diff --git a/packages/sdk/browser/src/index.ts b/packages/sdk/browser/src/index.ts index dbd867a42..045fafb84 100644 --- a/packages/sdk/browser/src/index.ts +++ b/packages/sdk/browser/src/index.ts @@ -6,7 +6,7 @@ * In typical usage, you will call {@link initialize} once at startup time to obtain an instance of * {@link LDClient}, which provides access to all of the SDK's functionality. * - * For more information, see the SDK reference guide. + * For more information, see the [SDK Reference Guide](https://docs.launchdarkly.com/sdk/client-side/javascript). * * @packageDocumentation */ @@ -74,11 +74,11 @@ export type { * Usage: * ``` * import { initialize } from 'launchdarkly-js-client-sdk'; - * const client = initialize(envKey, context, options); + * const client = initialize(clientSideId, context, options); * ``` * * @param clientSideId - * The client-side id, also known as the environment ID. + * The client-side ID, also known as the environment ID. * @param options * Optional configuration settings. * @return @@ -90,10 +90,11 @@ export function initialize(clientSideId: string, options?: LDOptions): LDClient } /** - * Provides a simple {@link LDLogger} implementation. + * Provides a basic {@link LDLogger} implementation. * - * This logging implementation uses a simple format that includes only the log level - * and the message text. By default the output is written to `console.error`. + * This logging implementation uses a basic format that includes only the log level + * and the message text. By default this uses log level 'info' and the output is + * written to `console.error`. * * To use the logger created by this function, put it into {@link LDOptions.logger}. If * you do not set {@link LDOptions.logger} to anything, the SDK uses a default logger diff --git a/packages/sdk/browser/src/options.ts b/packages/sdk/browser/src/options.ts index 3cb4e3568..89e53a4c8 100644 --- a/packages/sdk/browser/src/options.ts +++ b/packages/sdk/browser/src/options.ts @@ -24,6 +24,9 @@ export interface BrowserOptions extends Omit string; @@ -39,10 +42,10 @@ export interface BrowserOptions extends Omit