launchdarkly-js-client-sdk 3.3.0 → 3.5.0

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.3.0",
3
+ "version": "3.5.0",
4
4
  "description": "LaunchDarkly SDK for JavaScript",
5
5
  "author": "LaunchDarkly <team@launchdarkly.com>",
6
6
  "license": "Apache-2.0",
@@ -38,7 +38,8 @@
38
38
  "test:junit": "cross-env NODE_ENV=test jest --testResultsProcessor jest-junit",
39
39
  "check-typescript": "node_modules/typescript/bin/tsc",
40
40
  "clean": "rimraf dist/**",
41
- "prepublishOnly": "npm run build:min"
41
+ "prepublishOnly": "npm run build:min",
42
+ "doc": "typedoc"
42
43
  },
43
44
  "devDependencies": {
44
45
  "@babel/cli": "^7.19.3",
@@ -72,12 +73,13 @@
72
73
  "rollup-plugin-node-globals": "^1.4.0",
73
74
  "rollup-plugin-terser": "^7.0.2",
74
75
  "sinon": "^14.0.0",
75
- "typescript": "^4.8.4",
76
+ "typescript": "~5.4.5",
77
+ "typedoc": "^0.25.13",
76
78
  "@types/estree": "^1.0.0"
77
79
  },
78
80
  "dependencies": {
79
81
  "escape-string-regexp": "^4.0.0",
80
- "launchdarkly-js-sdk-common": "5.2.0"
82
+ "launchdarkly-js-sdk-common": "5.4.0"
81
83
  },
82
84
  "repository": {
83
85
  "type": "git",
package/typings.d.ts CHANGED
@@ -1,7 +1,16 @@
1
- // Put top level documentation into docs/doc.md.
1
+ /**
2
+ * This is the API reference for the LaunchDarkly SDK for browser JavaScript.
3
+ *
4
+ * In typical usage, you will call {@link initialize} once at startup time to obtain an instance of
5
+ * {@link LDClient}, which provides access to all of the SDK's functionality.
6
+ *
7
+ * For more information, see the [SDK reference guide](https://docs.launchdarkly.com/sdk/client-side/javascript).
8
+ *
9
+ * @packageDocumentation
10
+ */
11
+
2
12
  declare module 'launchdarkly-js-client-sdk' {
3
13
 
4
- //// DOCBUILD-START-REPLACE (see docs/Makefile)
5
14
  export * from 'launchdarkly-js-sdk-common';
6
15
  import {
7
16
  BasicLoggerOptions,
@@ -10,7 +19,6 @@ declare module 'launchdarkly-js-client-sdk' {
10
19
  LDLogger,
11
20
  LDOptionsBase,
12
21
  } from 'launchdarkly-js-sdk-common';
13
- //// DOCBUILD-END-REPLACE
14
22
 
15
23
  /**
16
24
  * Creates an instance of the LaunchDarkly client.
@@ -133,7 +141,7 @@ declare module 'launchdarkly-js-client-sdk' {
133
141
  *
134
142
  * @param options Configuration for the logger. If no options are specified, the
135
143
  * logger uses `{ level: 'info' }`.
136
- *
144
+ *
137
145
  * @example
138
146
  * This example shows how to use `basicLogger` in your SDK options to enable console
139
147
  * logging only at `warn` and `error` levels.