Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kics223w1
Copy link

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