launchdarkly-js-client-sdk 3.0.0-alpha.1 → 3.0.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "launchdarkly-js-client-sdk",
3
- "version": "3.0.0-alpha.1",
3
+ "version": "3.0.0-alpha.3",
4
4
  "description": "LaunchDarkly SDK for JavaScript",
5
5
  "author": "LaunchDarkly <team@launchdarkly.com>",
6
6
  "license": "Apache-2.0",
@@ -77,7 +77,7 @@
77
77
  },
78
78
  "dependencies": {
79
79
  "escape-string-regexp": "^4.0.0",
80
- "launchdarkly-js-sdk-common": "5.0.0-alpha.1"
80
+ "launchdarkly-js-sdk-common": "5.0.0-alpha.3"
81
81
  },
82
82
  "repository": {
83
83
  "type": "git",
package/typings.d.ts CHANGED
@@ -24,7 +24,7 @@ declare module 'launchdarkly-js-client-sdk' {
24
24
  *
25
25
  * // Preferred usage:
26
26
  * import { initialize } from 'launchdarkly-js-client-sdk';
27
- * const client = initialize(envKey, user, options);
27
+ * const client = initialize(envKey, context, options);
28
28
  *
29
29
  * // Deprecated usage:
30
30
  * import LaunchDarkly from 'launchdarkly-js-client-sdk';
@@ -32,20 +32,20 @@ declare module 'launchdarkly-js-client-sdk' {
32
32
  *
33
33
  * @param envKey
34
34
  * The environment ID.
35
- * @param user
36
- * The initial user properties. These can be changed later with [[LDClient.identify]].
35
+ * @param context
36
+ * The initial context properties. These can be changed later with [[LDClient.identify]].
37
37
  * @param options
38
38
  * Optional configuration settings.
39
39
  * @return
40
40
  * The new client instance.
41
41
  */
42
- export function initialize(envKey: string, user: LDContext, options?: LDOptions): LDClient;
42
+ export function initialize(envKey: string, context: LDContext, options?: LDOptions): LDClient;
43
43
 
44
44
  // This is @ignored because TypeDoc does not show default exports correctly. We'll just explain
45
45
  // the export situation in the comment for initialize().
46
46
  /** @ignore */
47
47
  const LaunchDarkly: {
48
- initialize: (envKey: string, user: LDContext, options?: LDOptions) => LDClient;
48
+ initialize: (envKey: string, context: LDContext, options?: LDOptions) => LDClient;
49
49
  version: string;
50
50
  };
51
51
 
@@ -57,7 +57,7 @@ declare module 'launchdarkly-js-client-sdk' {
57
57
  */
58
58
  export interface LDOptions extends LDOptionsBase {
59
59
  /**
60
- * The signed user key for Secure Mode.
60
+ * The signed context key for Secure Mode.
61
61
  *
62
62
  * For more information, see the JavaScript SDK Reference Guide on
63
63
  * [Secure mode](https://docs.launchdarkly.com/sdk/features/secure-mode#configuring-secure-mode-in-the-javascript-client-side-sdk).