Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Fix README: Rename user to clientUser in TelemetryDeck Initialization Example#30

Open
kics223w1 wants to merge 1 commit into
TelemetryDeck:mainTelemetryDeck/JavaScriptSDK:mainfrom
kics223w1:docs/read-mekics223w1/JavaScriptSDK:docs/read-meCopy head branch name to clipboard
Open

Fix README: Rename user to clientUser in TelemetryDeck Initialization Example#30
kics223w1 wants to merge 1 commit into
TelemetryDeck:mainTelemetryDeck/JavaScriptSDK:mainfrom
kics223w1:docs/read-mekics223w1/JavaScriptSDK:docs/read-meCopy head branch name to clipboard

Conversation

@kics223w1
Copy link
Copy Markdown

Bug Report: Incorrect Property Name in TelemetryDeck SDK README

Description

When initializing the SDK as shown in the README, the following error occurs:

Object literal may only specify known properties, and 'user' does not exist in type 'TelemetryDeckOptions'.

This happens because the TelemetryDeck class has renamed the user property to clientUser, but the README still references user.

Steps to Reproduce

  1. Install the Telemetry Deck JavaScript SDK:
  npm install @telemetrydeck/sdk
  1. Initialize the SDK with the following code:
const td = new TelemetryDeck({
  appID: '<YOUR_APP_ID>',
  user: '<YOUR_USER_IDENTIFIER>',
});
  1. The error will appear due to the incorrect property name.

Expected Behavior

The README should be updated to reflect the correct property name:

const td = new TelemetryDeck({
  appID: '<YOUR_APP_ID>',
  clientUser: '<YOUR_USER_IDENTIFIER>',
});

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Morty Proxy This is a proxified and sanitized view of the page, visit original site.