launchdarkly-js-client-sdk 3.1.3 → 3.1.4
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/CHANGELOG.md +4 -0
- package/README.md +2 -2
- package/dist/ldclient.cjs.js +1 -1
- package/dist/ldclient.cjs.js.map +1 -1
- package/dist/ldclient.es.js +1 -1
- package/dist/ldclient.es.js.map +1 -1
- package/dist/ldclient.min.js +1 -1
- package/dist/ldclient.min.js.map +1 -1
- package/package.json +1 -1
- package/typings.d.ts +7 -7
package/package.json
CHANGED
package/typings.d.ts
CHANGED
|
@@ -65,10 +65,10 @@ declare module 'launchdarkly-js-client-sdk' {
|
|
|
65
65
|
hash?: string;
|
|
66
66
|
|
|
67
67
|
/**
|
|
68
|
-
* Whether the client should make a request to LaunchDarkly for
|
|
68
|
+
* Whether the client should make a request to LaunchDarkly for Experimentation metrics (goals).
|
|
69
69
|
*
|
|
70
70
|
* This is true by default, meaning that this request will be made on every page load.
|
|
71
|
-
* Set it to false if you are not using
|
|
71
|
+
* Set it to false if you are not using Experimentation and want to skip the request.
|
|
72
72
|
*/
|
|
73
73
|
fetchGoals?: boolean;
|
|
74
74
|
|
|
@@ -99,15 +99,15 @@ declare module 'launchdarkly-js-client-sdk' {
|
|
|
99
99
|
*/
|
|
100
100
|
export interface LDClient extends LDClientBase {
|
|
101
101
|
/**
|
|
102
|
-
* Allows you to wait until the client has received goals data from LaunchDarkly.
|
|
102
|
+
* Allows you to wait until the client has received metrics (goals) data from LaunchDarkly.
|
|
103
103
|
*
|
|
104
|
-
* This is only relevant if you are using
|
|
105
|
-
* pageview events
|
|
106
|
-
* happens immediately after the initial request for feature flags
|
|
104
|
+
* This is only relevant if you are using Experimentation features like click events and
|
|
105
|
+
* pageview events. Until the client has received the configuration for these, which
|
|
106
|
+
* happens immediately after the initial request for feature flags, click events and
|
|
107
107
|
* pageview events will not work, so you may wish to wait using this method before
|
|
108
108
|
* doing anything that you expect to generate those events.
|
|
109
109
|
*
|
|
110
|
-
* The returned Promise will be resolved once the client has received
|
|
110
|
+
* The returned Promise will be resolved once the client has received metrics data. If
|
|
111
111
|
* you prefer to use event handlers rather than Promises, you can listen on the client
|
|
112
112
|
* for a `"goalsReady"` event instead.
|
|
113
113
|
*
|