@splitsoftware/splitio-commons 2.5.1-rc.0 → 2.6.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/CHANGES.txt +1 -1
- package/README.md +18 -18
- package/cjs/logger/messages/info.js +1 -1
- package/cjs/sdkFactory/index.js +1 -1
- package/cjs/storages/inLocalStorage/storageAdapter.js +2 -2
- package/esm/logger/messages/info.js +1 -1
- package/esm/sdkFactory/index.js +1 -1
- package/esm/storages/inLocalStorage/storageAdapter.js +2 -2
- package/package.json +1 -1
- package/src/logger/messages/info.ts +1 -1
- package/src/sdkFactory/index.ts +1 -1
- package/src/storages/inLocalStorage/storageAdapter.ts +2 -2
- package/types/splitio.d.ts +22 -22
package/CHANGES.txt
CHANGED
package/README.md
CHANGED
|
@@ -24,24 +24,24 @@ To learn more about Split, contact hello@split.io, or get started with feature f
|
|
|
24
24
|
|
|
25
25
|
Split has built and maintains SDKs for:
|
|
26
26
|
|
|
27
|
-
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://
|
|
28
|
-
* Android [Github](https://github.com/splitio/android-client) [Docs](https://
|
|
29
|
-
* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://
|
|
30
|
-
* Elixir thin-client [Github](https://github.com/splitio/elixir-thin-client) [Docs](https://
|
|
31
|
-
* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://
|
|
32
|
-
* GO [Github](https://github.com/splitio/go-client) [Docs](https://
|
|
33
|
-
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://
|
|
34
|
-
* Java [Github](https://github.com/splitio/java-client) [Docs](https://
|
|
35
|
-
* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://
|
|
36
|
-
* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://
|
|
37
|
-
* Node.js [Github](https://github.com/splitio/javascript-client) [Docs](https://
|
|
38
|
-
* PHP [Github](https://github.com/splitio/php-client) [Docs](https://
|
|
39
|
-
* PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://
|
|
40
|
-
* Python [Github](https://github.com/splitio/python-client) [Docs](https://
|
|
41
|
-
* React [Github](https://github.com/splitio/react-client) [Docs](https://
|
|
42
|
-
* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://
|
|
43
|
-
* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://
|
|
44
|
-
* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://
|
|
27
|
+
* .NET [Github](https://github.com/splitio/dotnet-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/net-sdk/)
|
|
28
|
+
* Android [Github](https://github.com/splitio/android-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/android-sdk/)
|
|
29
|
+
* Angular [Github](https://github.com/splitio/angular-sdk-plugin) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/angular-utilities/)
|
|
30
|
+
* Elixir thin-client [Github](https://github.com/splitio/elixir-thin-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/elixir-thin-client-sdk/)
|
|
31
|
+
* Flutter [Github](https://github.com/splitio/flutter-sdk-plugin) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/flutter-plugin/)
|
|
32
|
+
* GO [Github](https://github.com/splitio/go-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/go-sdk/)
|
|
33
|
+
* iOS [Github](https://github.com/splitio/ios-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/ios-sdk/)
|
|
34
|
+
* Java [Github](https://github.com/splitio/java-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/java-sdk/)
|
|
35
|
+
* JavaScript [Github](https://github.com/splitio/javascript-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk/)
|
|
36
|
+
* JavaScript for Browser [Github](https://github.com/splitio/javascript-browser-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk/)
|
|
37
|
+
* Node.js [Github](https://github.com/splitio/javascript-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk/)
|
|
38
|
+
* PHP [Github](https://github.com/splitio/php-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/php-sdk/)
|
|
39
|
+
* PHP thin-client [Github](https://github.com/splitio/php-thin-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/php-thin-client-sdk/)
|
|
40
|
+
* Python [Github](https://github.com/splitio/python-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/python-sdk/)
|
|
41
|
+
* React [Github](https://github.com/splitio/react-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/react-sdk/)
|
|
42
|
+
* React Native [Github](https://github.com/splitio/react-native-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/react-native-sdk/)
|
|
43
|
+
* Redux [Github](https://github.com/splitio/redux-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/redux-sdk/)
|
|
44
|
+
* Ruby [Github](https://github.com/splitio/ruby-client) [Docs](https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/ruby-sdk/)
|
|
45
45
|
|
|
46
46
|
For a comprehensive list of open source projects visit our [Github page](https://github.com/splitio?utf8=%E2%9C%93&query=%20only%3Apublic%20).
|
|
47
47
|
|
|
@@ -13,7 +13,7 @@ exports.codesInfo = warn_1.codesWarn.concat([
|
|
|
13
13
|
[c.IMPRESSION, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Feature flag: %s. Key: %s. Evaluation: %s. Label: %s'],
|
|
14
14
|
[c.IMPRESSION_QUEUEING, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Queueing corresponding impression.'],
|
|
15
15
|
[c.NEW_SHARED_CLIENT, 'New shared client instance created.'],
|
|
16
|
-
[c.NEW_FACTORY, 'New Split SDK instance created.'],
|
|
16
|
+
[c.NEW_FACTORY, 'New Split SDK instance created. %s'],
|
|
17
17
|
[c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
|
|
18
18
|
[c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
|
|
19
19
|
[c.USER_CONSENT_UPDATED, 'UserConsent: consent status changed from %s to %s.'],
|
package/cjs/sdkFactory/index.js
CHANGED
|
@@ -92,7 +92,7 @@ function sdkFactory(params) {
|
|
|
92
92
|
initCallbacks.forEach(function (cb) { return cb(); });
|
|
93
93
|
initCallbacks.length = 0;
|
|
94
94
|
}
|
|
95
|
-
log.info(constants_1.NEW_FACTORY);
|
|
95
|
+
log.info(constants_1.NEW_FACTORY, [settings.version]);
|
|
96
96
|
// @ts-ignore
|
|
97
97
|
return (0, objectAssign_1.objectAssign)({
|
|
98
98
|
// Split evaluation and event tracking engine
|
|
@@ -15,14 +15,14 @@ function storageAdapter(log, prefix, wrapper) {
|
|
|
15
15
|
cache = JSON.parse(storedCache || '{}');
|
|
16
16
|
keys = Object.keys(cache);
|
|
17
17
|
}).catch(function (e) {
|
|
18
|
-
log.error(constants_1.LOG_PREFIX + '
|
|
18
|
+
log.error(constants_1.LOG_PREFIX + 'Error calling wrapper `getItem` method: ' + e);
|
|
19
19
|
}));
|
|
20
20
|
},
|
|
21
21
|
save: function () {
|
|
22
22
|
return savePromise = savePromise.then(function () {
|
|
23
23
|
return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
|
|
24
24
|
}).catch(function (e) {
|
|
25
|
-
log.error(constants_1.LOG_PREFIX + '
|
|
25
|
+
log.error(constants_1.LOG_PREFIX + 'Error calling wrapper `setItem` method: ' + e);
|
|
26
26
|
});
|
|
27
27
|
},
|
|
28
28
|
whenSaved: function () {
|
|
@@ -9,7 +9,7 @@ export var codesInfo = codesWarn.concat([
|
|
|
9
9
|
[c.IMPRESSION, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Feature flag: %s. Key: %s. Evaluation: %s. Label: %s'],
|
|
10
10
|
[c.IMPRESSION_QUEUEING, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Queueing corresponding impression.'],
|
|
11
11
|
[c.NEW_SHARED_CLIENT, 'New shared client instance created.'],
|
|
12
|
-
[c.NEW_FACTORY, 'New Split SDK instance created.'],
|
|
12
|
+
[c.NEW_FACTORY, 'New Split SDK instance created. %s'],
|
|
13
13
|
[c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
|
|
14
14
|
[c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
|
|
15
15
|
[c.USER_CONSENT_UPDATED, 'UserConsent: consent status changed from %s to %s.'],
|
package/esm/sdkFactory/index.js
CHANGED
|
@@ -89,7 +89,7 @@ export function sdkFactory(params) {
|
|
|
89
89
|
initCallbacks.forEach(function (cb) { return cb(); });
|
|
90
90
|
initCallbacks.length = 0;
|
|
91
91
|
}
|
|
92
|
-
log.info(NEW_FACTORY);
|
|
92
|
+
log.info(NEW_FACTORY, [settings.version]);
|
|
93
93
|
// @ts-ignore
|
|
94
94
|
return objectAssign({
|
|
95
95
|
// Split evaluation and event tracking engine
|
|
@@ -12,14 +12,14 @@ export function storageAdapter(log, prefix, wrapper) {
|
|
|
12
12
|
cache = JSON.parse(storedCache || '{}');
|
|
13
13
|
keys = Object.keys(cache);
|
|
14
14
|
}).catch(function (e) {
|
|
15
|
-
log.error(LOG_PREFIX + '
|
|
15
|
+
log.error(LOG_PREFIX + 'Error calling wrapper `getItem` method: ' + e);
|
|
16
16
|
}));
|
|
17
17
|
},
|
|
18
18
|
save: function () {
|
|
19
19
|
return savePromise = savePromise.then(function () {
|
|
20
20
|
return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
|
|
21
21
|
}).catch(function (e) {
|
|
22
|
-
log.error(LOG_PREFIX + '
|
|
22
|
+
log.error(LOG_PREFIX + 'Error calling wrapper `setItem` method: ' + e);
|
|
23
23
|
});
|
|
24
24
|
},
|
|
25
25
|
whenSaved: function () {
|
package/package.json
CHANGED
|
@@ -11,7 +11,7 @@ export const codesInfo: [number, string][] = codesWarn.concat([
|
|
|
11
11
|
[c.IMPRESSION, c.LOG_PREFIX_IMPRESSIONS_TRACKER +'Feature flag: %s. Key: %s. Evaluation: %s. Label: %s'],
|
|
12
12
|
[c.IMPRESSION_QUEUEING, c.LOG_PREFIX_IMPRESSIONS_TRACKER +'Queueing corresponding impression.'],
|
|
13
13
|
[c.NEW_SHARED_CLIENT, 'New shared client instance created.'],
|
|
14
|
-
[c.NEW_FACTORY, 'New Split SDK instance created.'],
|
|
14
|
+
[c.NEW_FACTORY, 'New Split SDK instance created. %s'],
|
|
15
15
|
[c.EVENTS_TRACKER_SUCCESS, c.LOG_PREFIX_EVENTS_TRACKER + 'Successfully queued %s'],
|
|
16
16
|
[c.IMPRESSIONS_TRACKER_SUCCESS, c.LOG_PREFIX_IMPRESSIONS_TRACKER + 'Successfully stored %s impression(s).'],
|
|
17
17
|
[c.USER_CONSENT_UPDATED, 'UserConsent: consent status changed from %s to %s.'],
|
package/src/sdkFactory/index.ts
CHANGED
|
@@ -19,7 +19,7 @@ export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.St
|
|
|
19
19
|
cache = JSON.parse(storedCache || '{}');
|
|
20
20
|
keys = Object.keys(cache);
|
|
21
21
|
}).catch((e) => {
|
|
22
|
-
log.error(LOG_PREFIX + '
|
|
22
|
+
log.error(LOG_PREFIX + 'Error calling wrapper `getItem` method: ' + e);
|
|
23
23
|
}));
|
|
24
24
|
},
|
|
25
25
|
|
|
@@ -27,7 +27,7 @@ export function storageAdapter(log: ILogger, prefix: string, wrapper: SplitIO.St
|
|
|
27
27
|
return savePromise = savePromise.then(() => {
|
|
28
28
|
return Promise.resolve(wrapper.setItem(prefix, JSON.stringify(cache)));
|
|
29
29
|
}).catch((e) => {
|
|
30
|
-
log.error(LOG_PREFIX + '
|
|
30
|
+
log.error(LOG_PREFIX + 'Error calling wrapper `setItem` method: ' + e);
|
|
31
31
|
});
|
|
32
32
|
},
|
|
33
33
|
|
package/types/splitio.d.ts
CHANGED
|
@@ -132,7 +132,7 @@ interface IPluggableSharedSettings {
|
|
|
132
132
|
/**
|
|
133
133
|
* Boolean value to indicate whether the logger should be enabled or disabled by default, or a log level string or a Logger object.
|
|
134
134
|
* Passing a logger object is required to get descriptive log messages. Otherwise most logs will print with message codes.
|
|
135
|
-
* @see {@link https://
|
|
135
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk/#logging}.
|
|
136
136
|
*
|
|
137
137
|
* Examples:
|
|
138
138
|
* ```
|
|
@@ -179,7 +179,7 @@ interface IServerSideSharedSettings {
|
|
|
179
179
|
/**
|
|
180
180
|
* Your SDK key.
|
|
181
181
|
*
|
|
182
|
-
* @see {@link https://
|
|
182
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/account-settings/api-keys/}
|
|
183
183
|
*/
|
|
184
184
|
authorizationKey: string;
|
|
185
185
|
/**
|
|
@@ -282,7 +282,7 @@ interface IServerSideSharedSettings {
|
|
|
282
282
|
eventsQueueSize?: number;
|
|
283
283
|
/**
|
|
284
284
|
* For mocking/testing only. The SDK will refresh the features mocked data when mode is set to "localhost" by defining the key.
|
|
285
|
-
* For more information see {@link https://
|
|
285
|
+
* For more information see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk/#localhost-mode}
|
|
286
286
|
*
|
|
287
287
|
* @defaultValue `15`
|
|
288
288
|
*/
|
|
@@ -297,7 +297,7 @@ interface IServerSideSharedSettings {
|
|
|
297
297
|
};
|
|
298
298
|
/**
|
|
299
299
|
* Mocked features file path. For testing purposes only. For using this you should specify "localhost" as authorizationKey on core settings.
|
|
300
|
-
* @see {@link https://
|
|
300
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk/#localhost-mode}
|
|
301
301
|
*
|
|
302
302
|
* @defaultValue `'$HOME/.split'`
|
|
303
303
|
*/
|
|
@@ -314,13 +314,13 @@ interface IClientSideSharedSettings {
|
|
|
314
314
|
/**
|
|
315
315
|
* Your SDK key.
|
|
316
316
|
*
|
|
317
|
-
* @see {@link https://
|
|
317
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/account-settings/api-keys/}
|
|
318
318
|
*/
|
|
319
319
|
authorizationKey: string;
|
|
320
320
|
/**
|
|
321
321
|
* Customer identifier. Whatever this means to you.
|
|
322
322
|
*
|
|
323
|
-
* @see {@link https://
|
|
323
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/fme-settings/traffic-types/}
|
|
324
324
|
*/
|
|
325
325
|
key: SplitIO.SplitKey;
|
|
326
326
|
/**
|
|
@@ -347,7 +347,7 @@ interface IClientSideSharedSettings {
|
|
|
347
347
|
interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISyncSharedSettings {
|
|
348
348
|
/**
|
|
349
349
|
* Mocked features map. For testing purposes only. For using this you should specify "localhost" as authorizationKey on core settings.
|
|
350
|
-
* @see {@link https://
|
|
350
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk/#localhost-mode}
|
|
351
351
|
*/
|
|
352
352
|
features?: SplitIO.MockedFeaturesMap;
|
|
353
353
|
/**
|
|
@@ -442,7 +442,7 @@ interface IClientSideSyncSharedSettings extends IClientSideSharedSettings, ISync
|
|
|
442
442
|
eventsQueueSize?: number;
|
|
443
443
|
/**
|
|
444
444
|
* For mocking/testing only. The SDK will refresh the features mocked data when mode is set to "localhost" by defining the key.
|
|
445
|
-
* For more information see {@link https://
|
|
445
|
+
* For more information see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk/#localhost-mode}
|
|
446
446
|
*
|
|
447
447
|
* @defaultValue `15`
|
|
448
448
|
*/
|
|
@@ -794,7 +794,7 @@ declare namespace SplitIO {
|
|
|
794
794
|
/**
|
|
795
795
|
* Attributes should be on object with values of type string, boolean, number (dates should be sent as millis since epoch) or array of strings or numbers.
|
|
796
796
|
*
|
|
797
|
-
* @see {@link https://
|
|
797
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk/#attribute-syntax}
|
|
798
798
|
*/
|
|
799
799
|
type Attributes = {
|
|
800
800
|
[attributeName: string]: AttributeType;
|
|
@@ -806,7 +806,7 @@ declare namespace SplitIO {
|
|
|
806
806
|
/**
|
|
807
807
|
* Properties should be an object with values of type string, number, boolean or null. Size limit of ~31kb.
|
|
808
808
|
*
|
|
809
|
-
* @see {@link https://
|
|
809
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk/#track}
|
|
810
810
|
*/
|
|
811
811
|
type Properties = {
|
|
812
812
|
[propertyName: string]: string | number | boolean | null;
|
|
@@ -1076,7 +1076,7 @@ declare namespace SplitIO {
|
|
|
1076
1076
|
* Impression listener interface. This is the interface that needs to be implemented
|
|
1077
1077
|
* by the element you provide to the SDK as impression listener.
|
|
1078
1078
|
*
|
|
1079
|
-
* @see {@link https://
|
|
1079
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk/#listener}
|
|
1080
1080
|
*/
|
|
1081
1081
|
interface IImpressionListener {
|
|
1082
1082
|
logImpression(data: ImpressionData): void;
|
|
@@ -1211,7 +1211,7 @@ declare namespace SplitIO {
|
|
|
1211
1211
|
/**
|
|
1212
1212
|
* Settings interface for Browser SDK instances created with client-side API and synchronous storage (e.g., in-memory or local storage).
|
|
1213
1213
|
*
|
|
1214
|
-
* @see {@link https://
|
|
1214
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk/#configuration}
|
|
1215
1215
|
*/
|
|
1216
1216
|
interface IClientSideSettings extends IClientSideSyncSharedSettings, IPluggableSharedSettings {
|
|
1217
1217
|
/**
|
|
@@ -1232,20 +1232,20 @@ declare namespace SplitIO {
|
|
|
1232
1232
|
/**
|
|
1233
1233
|
* Settings interface for React Native SDK instances, with client-side API and synchronous storage.
|
|
1234
1234
|
*
|
|
1235
|
-
* @see {@link https://
|
|
1235
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/react-native-sdk/#configuration}
|
|
1236
1236
|
*/
|
|
1237
1237
|
interface IReactNativeSettings extends IClientSideSettings { }
|
|
1238
1238
|
/**
|
|
1239
1239
|
* Settings interface for Browser SDK instances created with client-side API and asynchronous storage (e.g., serverless environments with a persistent storage).
|
|
1240
1240
|
* If your storage is synchronous (by default we use memory, which is sync) use SplitIO.IClientSideSettings instead.
|
|
1241
1241
|
*
|
|
1242
|
-
* @see {@link https://
|
|
1242
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk/#sharing-state-with-a-pluggable-storage}
|
|
1243
1243
|
*/
|
|
1244
1244
|
interface IClientSideAsyncSettings extends IClientSideSharedSettings, ISharedSettings, IPluggableSharedSettings {
|
|
1245
1245
|
/**
|
|
1246
1246
|
* The SDK mode. When using `PluggableStorage` as storage, the possible values are "consumer" and "consumer_partial".
|
|
1247
1247
|
*
|
|
1248
|
-
* @see {@link https://
|
|
1248
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/browser-sdk/#sharing-state-with-a-pluggable-storage}
|
|
1249
1249
|
*/
|
|
1250
1250
|
mode: 'consumer' | 'consumer_partial';
|
|
1251
1251
|
/**
|
|
@@ -1331,7 +1331,7 @@ declare namespace SplitIO {
|
|
|
1331
1331
|
/**
|
|
1332
1332
|
* Settings interface for JavaScript SDK instances created on the browser, with client-side API and synchronous storage (e.g., in-memory or local storage).
|
|
1333
1333
|
*
|
|
1334
|
-
* @see {@link https://
|
|
1334
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/client-side-sdks/javascript-sdk/#configuration}
|
|
1335
1335
|
*/
|
|
1336
1336
|
interface IBrowserSettings extends IClientSideSyncSharedSettings, INonPluggableSharedSettings {
|
|
1337
1337
|
/**
|
|
@@ -1375,7 +1375,7 @@ declare namespace SplitIO {
|
|
|
1375
1375
|
* Settings interface for JavaScript SDK instances created on Node.js, with server-side API and synchronous in-memory storage.
|
|
1376
1376
|
* If your storage is asynchronous (Redis for example) use SplitIO.INodeAsyncSettings instead.
|
|
1377
1377
|
*
|
|
1378
|
-
* @see {@link https://
|
|
1378
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk/#configuration}
|
|
1379
1379
|
*/
|
|
1380
1380
|
interface INodeSettings extends IServerSideSharedSettings, ISyncSharedSettings, INonPluggableSharedSettings {
|
|
1381
1381
|
/**
|
|
@@ -1462,13 +1462,13 @@ declare namespace SplitIO {
|
|
|
1462
1462
|
* Settings interface for JavaScript SDK instances created on Node.js, with asynchronous storage like Redis.
|
|
1463
1463
|
* If your storage is synchronous (by default we use memory, which is sync) use SplitIO.INodeSettings instead.
|
|
1464
1464
|
*
|
|
1465
|
-
* @see {@link https://
|
|
1465
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk/#configuration}
|
|
1466
1466
|
*/
|
|
1467
1467
|
interface INodeAsyncSettings extends IServerSideSharedSettings, ISharedSettings, INonPluggableSharedSettings {
|
|
1468
1468
|
/**
|
|
1469
1469
|
* The SDK mode. When using 'REDIS' storage type, the only possible value is "consumer", which is required.
|
|
1470
1470
|
*
|
|
1471
|
-
* @see {@link https://
|
|
1471
|
+
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/sdks-and-infrastructure/server-side-sdks/nodejs-sdk/#state-sharing-redis-integration}
|
|
1472
1472
|
*/
|
|
1473
1473
|
mode: 'consumer';
|
|
1474
1474
|
/**
|
|
@@ -1742,7 +1742,7 @@ declare namespace SplitIO {
|
|
|
1742
1742
|
* Tracks an event to be fed to the results product on Split user interface.
|
|
1743
1743
|
*
|
|
1744
1744
|
* @param key - The key that identifies the entity related to this event.
|
|
1745
|
-
* @param trafficType - The traffic type of the entity related to this event. See {@link https://
|
|
1745
|
+
* @param trafficType - The traffic type of the entity related to this event. See {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/fme-settings/traffic-types/}
|
|
1746
1746
|
* @param eventType - The event type corresponding to this event.
|
|
1747
1747
|
* @param value - The value of this event.
|
|
1748
1748
|
* @param properties - The properties of this event. Values can be string, number, boolean or null.
|
|
@@ -1840,7 +1840,7 @@ declare namespace SplitIO {
|
|
|
1840
1840
|
* Tracks an event to be fed to the results product on Split user interface, and returns a promise to signal when the event was successfully queued (or not).
|
|
1841
1841
|
*
|
|
1842
1842
|
* @param key - The key that identifies the entity related to this event.
|
|
1843
|
-
* @param trafficType - The traffic type of the entity related to this event. See {@link https://
|
|
1843
|
+
* @param trafficType - The traffic type of the entity related to this event. See {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/fme-settings/traffic-types/}
|
|
1844
1844
|
* @param eventType - The event type corresponding to this event.
|
|
1845
1845
|
* @param value - The value of this event.
|
|
1846
1846
|
* @param properties - The properties of this event. Values can be string, number, boolean or null.
|
|
@@ -1970,7 +1970,7 @@ declare namespace SplitIO {
|
|
|
1970
1970
|
/**
|
|
1971
1971
|
* Tracks an event to be fed to the results product on Split user interface.
|
|
1972
1972
|
*
|
|
1973
|
-
* @param trafficType - The traffic type of the entity related to this event. See {@link https://
|
|
1973
|
+
* @param trafficType - The traffic type of the entity related to this event. See {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/fme-settings/traffic-types/}
|
|
1974
1974
|
* @param eventType - The event type corresponding to this event.
|
|
1975
1975
|
* @param value - The value of this event.
|
|
1976
1976
|
* @param properties - The properties of this event. Values can be string, number, boolean or null.
|