@splitsoftware/splitio-commons 2.0.0-rc.3 → 2.0.0-rc.5

package/CHANGES.txt

@@ -1,6 +1,7 @@
 2.0.0 (October XX, 2024)
  - Added support for targeting rules based on large segments.
  - Added `factory.destroy()` method, which invokes the `destroy` method on all SDK clients created by the factory.
+ - Added `SplitIO` namespace with the public TypeScript definitions to be reused by the SDKs, rather than having each SDK define its own types.
  - Updated the handling of timers and async operations inside an `init` factory method to enable lazy initialization of the SDK in standalone mode. This update is intended for the React SDK.
  - Bugfixing - Fixed an issue with the server-side polling manager that caused dangling timers when the SDK was destroyed before it was ready.
  - BREAKING CHANGES:

package/cjs/integrations/pluggable.js

@@ -6,8 +6,8 @@ var constants_1 = require("../utils/constants");
  * Factory function for IntegrationsManager with pluggable integrations.
  * The integrations manager instantiates integration, and bypass tracked events and impressions to them.
  *
- * @param integrations validated list of integration factories
- * @param params information of the Sdk factory instance that integrations can access to
+ * @param integrations - validated list of integration factories
+ * @param params - information of the Sdk factory instance that integrations can access to
  *
  * @returns integration manager or undefined if `integrations` are not present in settings.
  */

package/cjs/logger/sdkLogger.js

@@ -6,7 +6,7 @@ var constants_1 = require("./constants");
 /**
  * The public Logger utility API exposed via SplitFactory, used to update the log level.
  *
- * @param log the factory logger instance to handle
+ * @param log - the factory logger instance to handle
  */
 function createLoggerAPI(log) {
     function setLogLevel(logLevel) {
@@ -26,7 +26,7 @@ function createLoggerAPI(log) {
         },
         /**
          * Sets a custom log Level for the SDK.
-         * @param {string} logLevel - Custom LogLevel value.
+         * @param logLevel - Custom LogLevel value.
          */
         setLogLevel: setLogLevel,
         /**

package/cjs/readiness/sdkReadinessManager.js

@@ -12,8 +12,8 @@ var REMOVE_LISTENER_EVENT = 'removeListener';
  * SdkReadinessManager factory, which provides the public status API of SDK clients and manager: ready promise, readiness event emitter and constants (SDK_READY, etc).
  * It also updates logs related warnings and errors.
  *
- * @param readyTimeout time in millis to emit SDK_READY_TIME_OUT event
- * @param readinessManager optional readinessManager to use. only used internally for `shared` method
+ * @param readyTimeout - time in millis to emit SDK_READY_TIME_OUT event
+ * @param readinessManager - optional readinessManager to use. only used internally for `shared` method
  */
 function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
     if (readinessManager === void 0) { readinessManager = (0, readinessManager_1.readinessManagerFactory)(EventEmitter, settings); }
@@ -76,25 +76,6 @@ function sdkReadinessManagerFactory(EventEmitter, settings, readinessManager) {
                 SDK_UPDATE: constants_1.SDK_UPDATE,
                 SDK_READY_TIMED_OUT: constants_1.SDK_READY_TIMED_OUT,
             },
-            /**
-             * Returns a promise that will be resolved once the SDK has finished loading (SDK_READY event emitted) or rejected if the SDK has timedout (SDK_READY_TIMED_OUT event emitted).
-             * As it's meant to provide similar flexibility to the event approach, given that the SDK might be eventually ready after a timeout event, calling the `ready` method after the
-             * SDK had timed out will return a new promise that should eventually resolve if the SDK gets ready.
-             *
-             * Caveats: the method was designed to avoid an unhandled Promise rejection if the rejection case is not handled, so that `onRejected` handler is optional when using promises.
-             * However, when using async/await syntax, the rejection should be explicitly propagated like in the following example:
-             * ```
-             * try {
-             *   await client.ready().catch((e) => { throw e; });
-             *   // SDK is ready
-             * } catch(e) {
-             *   // SDK has timedout
-             * }
-             * ```
-             *
-             * @function ready
-             * @returns {Promise<void>}
-             */
             ready: function () {
                 if (readinessManager.hasTimedout()) {
                     if (!readinessManager.isReady()) {

package/cjs/sdkClient/client.js

@@ -165,7 +165,6 @@ function clientFactory(params) {
         getTreatmentsByFlagSet: getTreatmentsByFlagSet,
         getTreatmentsWithConfigByFlagSet: getTreatmentsWithConfigByFlagSet,
         track: track,
-        isClientSide: false
     };
 }
 exports.clientFactory = clientFactory;

package/cjs/sdkClient/clientAttributesDecoration.js

@@ -66,9 +66,9 @@ function clientAttributesDecoration(log, client) {
         /**
          * Add an attribute to client's in memory attributes storage
          *
-         * @param {string} attributeName Attrinute name
-         * @param {string, number, boolean, list} attributeValue Attribute value
-         * @returns {boolean} true if the attribute was stored and false otherways
+         * @param attributeName - Attribute name
+         * @param attributeValue - Attribute value
+         * @returns true if the attribute was stored and false otherways
          */
         setAttribute: function (attributeName, attributeValue) {
             var attribute = {};
@@ -81,8 +81,8 @@ function clientAttributesDecoration(log, client) {
         /**
          * Returns the attribute with the given name
          *
-         * @param {string} attributeName Attribute name
-         * @returns {Object} Attribute with the given name
+         * @param attributeName - Attribute name
+         * @returns Attribute with the given name
          */
         getAttribute: function (attributeName) {
             log.debug("retrieved attribute " + attributeName);
@@ -91,7 +91,7 @@ function clientAttributesDecoration(log, client) {
         /**
          * Add to client's in memory attributes storage the attributes in 'attributes'
          *
-         * @param {Object} attributes Object with attributes to store
+         * @param attributes - Object with attributes to store
          * @returns true if attributes were stored an false otherways
          */
         setAttributes: function (attributes) {
@@ -102,7 +102,7 @@ function clientAttributesDecoration(log, client) {
         /**
          * Return all the attributes stored in client's in memory attributes storage
          *
-         * @returns {Object} returns all the stored attributes
+         * @returns returns all the stored attributes
          */
         getAttributes: function () {
             return attributeStorage.getAll();
@@ -110,8 +110,8 @@ function clientAttributesDecoration(log, client) {
         /**
          * Removes from client's in memory attributes storage the attribute with the given name
          *
-         * @param {string} attributeName
-         * @returns {boolean} true if attribute was removed and false otherways
+         * @param attributeName - Attribute name
+         * @returns true if attribute was removed and false otherways
          */
         removeAttribute: function (attributeName) {
             log.debug("removed attribute " + attributeName);

package/cjs/sdkClient/clientCS.js

@@ -6,8 +6,8 @@ var clientAttributesDecoration_1 = require("./clientAttributesDecoration");
 /**
  * Decorator that binds a key to client methods
  *
- * @param client sync client instance
- * @param key validated split key
+ * @param client - sync client instance
+ * @param key - validated split key
  */
 function clientCSDecorator(log, client, key) {
     var clientCS = (0, clientAttributesDecoration_1.clientAttributesDecoration)(log, client);

package/cjs/services/splitApi.js

@@ -12,9 +12,9 @@ function userKeyToQueryParam(userKey) {
 /**
  * Factory of SplitApi objects, which group the collection of Split HTTP endpoints used by the SDK
  *
- * @param settings validated settings object
- * @param platform object containing environment-specific dependencies
- * @param telemetryTracker telemetry tracker
+ * @param settings - validated settings object
+ * @param platform - object containing environment-specific dependencies
+ * @param telemetryTracker - telemetry tracker
  */
 function splitApiFactory(settings, platform, telemetryTracker) {
     var urls = settings.urls;
@@ -67,8 +67,8 @@ function splitApiFactory(settings, platform, telemetryTracker) {
         /**
          * Post events.
          *
-         * @param body  Events bulk payload
-         * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+         * @param body -  Events bulk payload
+         * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
          */
         postEventsBulk: function (body, headers) {
             var url = urls.events + "/events/bulk";
@@ -77,8 +77,8 @@ function splitApiFactory(settings, platform, telemetryTracker) {
         /**
          * Post impressions.
          *
-         * @param body  Impressions bulk payload
-         * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+         * @param body -  Impressions bulk payload
+         * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
          */
         postTestImpressionsBulk: function (body, headers) {
             var url = urls.events + "/testImpressions/bulk";
@@ -92,8 +92,8 @@ function splitApiFactory(settings, platform, telemetryTracker) {
         /**
          * Post impressions counts.
          *
-         * @param body  Impressions counts payload
-         * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+         * @param body -  Impressions counts payload
+         * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
          */
         postTestImpressionsCount: function (body, headers) {
             var url = urls.events + "/testImpressions/count";
@@ -102,8 +102,8 @@ function splitApiFactory(settings, platform, telemetryTracker) {
         /**
          * Post unique keys for client side.
          *
-         * @param body  unique keys payload
-         * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+         * @param body -  unique keys payload
+         * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
          */
         postUniqueKeysBulkCs: function (body, headers) {
             var url = urls.telemetry + "/v1/keys/cs";
@@ -112,8 +112,8 @@ function splitApiFactory(settings, platform, telemetryTracker) {
         /**
          * Post unique keys for server side.
          *
-         * @param body  unique keys payload
-         * @param headers  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
+         * @param body -  unique keys payload
+         * @param headers -  Optionals headers to overwrite default ones. For example, it is used in producer mode to overwrite metadata headers.
          */
         postUniqueKeysBulkSs: function (body, headers) {
             var url = urls.telemetry + "/v1/keys/ss";

package/cjs/services/splitHttpClient.js

@@ -8,8 +8,8 @@ var messageNoFetch = 'Global fetch API is not available.';
 /**
  * Factory of Split HTTP clients, which are HTTP clients with predefined headers for Split endpoints.
  *
- * @param settings SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
- * @param platform object containing environment-specific dependencies
+ * @param settings - SDK settings, used to access authorizationKey, logger instance and metadata (SDK version, ip and hostname) to set additional headers
+ * @param platform - object containing environment-specific dependencies
  */
 function splitHttpClientFactory(settings, _a) {
     var getOptions = _a.getOptions, getFetch = _a.getFetch;

package/cjs/storages/AbstractSplitsCacheAsync.js

@@ -25,10 +25,7 @@ var AbstractSplitsCacheAsync = /** @class */ (function () {
      * Kill `name` split and set `defaultTreatment` and `changeNumber`.
      * Used for SPLIT_KILL push notifications.
      *
-     * @param {string} name
-     * @param {string} defaultTreatment
-     * @param {number} changeNumber
-     * @returns {Promise} a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
+     * @returns a promise that is resolved once the split kill operation is performed. The fulfillment value is a boolean: `true` if the operation successed updating the split or `false` if no split is updated,
      * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
      * The promise will never be rejected.
      */

package/cjs/storages/AbstractSplitsCacheSync.js

@@ -41,10 +41,7 @@ var AbstractSplitsCacheSync = /** @class */ (function () {
      * Kill `name` split and set `defaultTreatment` and `changeNumber`.
      * Used for SPLIT_KILL push notifications.
      *
-     * @param {string} name
-     * @param {string} defaultTreatment
-     * @param {number} changeNumber
-     * @returns {boolean} `true` if the operation successed updating the split, or `false` if no split is updated,
+     * @returns `true` if the operation successed updating the split, or `false` if no split is updated,
      * for instance, if the `changeNumber` is old, or if the split is not found (e.g., `/splitchanges` hasn't been fetched yet), or if the storage fails to apply the update.
      */
     AbstractSplitsCacheSync.prototype.killLocally = function (name, defaultTreatment, changeNumber) {

package/cjs/storages/dataLoader.js

@@ -5,7 +5,7 @@ var browser_1 = require("../utils/constants/browser");
 /**
  * Factory of client-side storage loader
  *
- * @param preloadedData validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
+ * @param preloadedData - validated data following the format proposed in https://github.com/godaddy/split-javascript-data-loader
  * and extended with a `mySegmentsData` property.
  * @returns function to preload the storage
  */
@@ -14,12 +14,11 @@ function dataLoaderFactory(preloadedData) {
      * Storage-agnostic adaptation of `loadDataIntoLocalStorage` function
      * (https://github.com/godaddy/split-javascript-data-loader/blob/master/src/load-data.js)
      *
-     * @param storage object containing `splits` and `segments` cache (client-side variant)
-     * @param userId user key string of the provided MySegmentsCache
-     *
-     * @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
-     * @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
+     * @param storage - object containing `splits` and `segments` cache (client-side variant)
+     * @param userId - user key string of the provided MySegmentsCache
      */
+    // @TODO extend to support SegmentsCache (server-side variant) by making `userId` optional and adding the corresponding logic.
+    // @TODO extend to load data on shared mySegments storages. Be specific when emitting SDK_READY_FROM_CACHE on shared clients. Maybe the serializer should provide the `useSegments` flag.
     return function loadData(storage, userId) {
         // Do not load data if current preloadedData is empty
         if (Object.keys(preloadedData).length === 0)

package/cjs/storages/findLatencyIndex.js

@@ -8,7 +8,7 @@ var BASE = 1.5;
 /**
  * Calculates buckets from latency in milliseconds
  *
- * @param latencyInMs
+ * @param latencyInMs - latency in milliseconds
  * @returns a bucket index from 0 to 22 inclusive
  */
 function findLatencyIndex(latencyInMs) {

package/cjs/storages/inLocalStorage/SplitsCacheInLocal.js

@@ -12,11 +12,6 @@ var sets_1 = require("../../utils/lang/sets");
  */
 var SplitsCacheInLocal = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(SplitsCacheInLocal, _super);
-    /**
-     * @param {KeyBuilderCS} keys
-     * @param {number | undefined} expirationTimestamp
-     * @param {ISplitFiltersValidation} splitFiltersValidation
-     */
     function SplitsCacheInLocal(settings, keys, expirationTimestamp) {
         var _this = _super.call(this) || this;
         _this.keys = keys;
@@ -197,7 +192,7 @@ var SplitsCacheInLocal = /** @class */ (function (_super) {
     /**
      * Clean Splits cache if its `lastUpdated` timestamp is older than the given `expirationTimestamp`,
      *
-     * @param {number | undefined} expirationTimestamp if the value is not a number, data will not be cleaned
+     * @param expirationTimestamp - if the value is not a number, data will not be cleaned
      */
     SplitsCacheInLocal.prototype._checkExpiration = function (expirationTimestamp) {
         var value = localStorage.getItem(this.keys.buildLastUpdatedKey());

package/cjs/storages/inMemory/AttributesCacheInMemory.js

@@ -9,9 +9,9 @@ var AttributesCacheInMemory = /** @class */ (function () {
     /**
      * Create or update the value for the given attribute
      *
-     * @param {string} attributeName attribute name
-     * @param {Object} attributeValue attribute value
-     * @returns {boolean} the attribute was stored
+     * @param attributeName - attribute name
+     * @param attributeValue - attribute value
+     * @returns the attribute was stored
      */
     AttributesCacheInMemory.prototype.setAttribute = function (attributeName, attributeValue) {
         this.attributesCache[attributeName] = attributeValue;
@@ -20,8 +20,8 @@ var AttributesCacheInMemory = /** @class */ (function () {
     /**
      * Retrieves the value of a given attribute
      *
-     * @param {string} attributeName attribute name
-     * @returns {Object?} stored attribute value
+     * @param attributeName - attribute name
+     * @returns stored attribute value
      */
     AttributesCacheInMemory.prototype.getAttribute = function (attributeName) {
         return this.attributesCache[attributeName];
@@ -29,8 +29,8 @@ var AttributesCacheInMemory = /** @class */ (function () {
     /**
      * Create or update all the given attributes
      *
-     * @param {[string, Object]} attributes attributes to create or update
-     * @returns {boolean} attributes were stored
+     * @param attributes - attributes to create or update
+     * @returns attributes were stored
      */
     AttributesCacheInMemory.prototype.setAttributes = function (attributes) {
         this.attributesCache = (0, objectAssign_1.objectAssign)(this.attributesCache, attributes);
@@ -39,7 +39,7 @@ var AttributesCacheInMemory = /** @class */ (function () {
     /**
      * Retrieve the full attributes map
      *
-     * @returns {Map<string, Object>} stored attributes
+     * @returns stored attributes
      */
     AttributesCacheInMemory.prototype.getAll = function () {
         return this.attributesCache;
@@ -47,8 +47,8 @@ var AttributesCacheInMemory = /** @class */ (function () {
     /**
      * Removes a given attribute from the map
      *
-     * @param {string} attributeName attribute to remove
-     * @returns {boolean} attribute removed
+     * @param attributeName - attribute to remove
+     * @returns attribute removed
      */
     AttributesCacheInMemory.prototype.removeAttribute = function (attributeName) {
         if (Object.keys(this.attributesCache).indexOf(attributeName) >= 0) {

package/cjs/storages/inMemory/EventsCacheInMemory.js

@@ -5,7 +5,7 @@ var MAX_QUEUE_BYTE_SIZE = 5 * 1024 * 1024; // 5M
 var EventsCacheInMemory = /** @class */ (function () {
     /**
      *
-     * @param eventsQueueSize number of queued events to call onFullQueueCb.
+     * @param eventsQueueSize - number of queued events to call onFullQueueCb.
      * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
      */
     function EventsCacheInMemory(eventsQueueSize) {

package/cjs/storages/inMemory/ImpressionsCacheInMemory.js

@@ -4,7 +4,7 @@ exports.ImpressionsCacheInMemory = void 0;
 var ImpressionsCacheInMemory = /** @class */ (function () {
     /**
      *
-     * @param impressionsQueueSize number of queued impressions to call onFullQueueCb.
+     * @param impressionsQueueSize - number of queued impressions to call onFullQueueCb.
      * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
      */
     function ImpressionsCacheInMemory(impressionsQueueSize) {

package/cjs/storages/inMemory/InMemoryStorage.js

@@ -12,7 +12,7 @@ var UniqueKeysCacheInMemory_1 = require("./UniqueKeysCacheInMemory");
 /**
  * InMemory storage factory for standalone server-side SplitFactory
  *
- * @param params parameters required by EventsCacheSync
+ * @param params - parameters required by EventsCacheSync
  */
 function InMemoryStorageFactory(params) {
     var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;

package/cjs/storages/inMemory/InMemoryStorageCS.js

@@ -12,7 +12,7 @@ var UniqueKeysCacheInMemoryCS_1 = require("./UniqueKeysCacheInMemoryCS");
 /**
  * InMemory storage factory for standalone client-side SplitFactory
  *
- * @param params parameters required by EventsCacheSync
+ * @param params - parameters required by EventsCacheSync
  */
 function InMemoryStorageCSFactory(params) {
     var _a = params.settings, _b = _a.scheduler, impressionsQueueSize = _b.impressionsQueueSize, eventsQueueSize = _b.eventsQueueSize, _c = _a.sync, impressionsMode = _c.impressionsMode, __splitFiltersValidation = _c.__splitFiltersValidation;

package/cjs/storages/inMemory/UniqueKeysCacheInMemoryCS.js

@@ -6,7 +6,7 @@ var sets_1 = require("../../utils/lang/sets");
 var UniqueKeysCacheInMemoryCS = /** @class */ (function () {
     /**
      *
-     * @param impressionsQueueSize number of queued impressions to call onFullQueueCb.
+     * @param impressionsQueueSize - number of queued impressions to call onFullQueueCb.
      * Default value is 0, that means no maximum value, in case we want to avoid this being triggered.
      */
     function UniqueKeysCacheInMemoryCS(uniqueKeysQueueSize) {

package/cjs/storages/inRedis/SplitsCacheInRedis.js

@@ -164,10 +164,8 @@ var SplitsCacheInRedis = /** @class */ (function (_super) {
      * Get list of all split definitions.
      * The returned promise is resolved with the list of split definitions,
      * or rejected if redis operation fails.
-     *
-     * @TODO we need to benchmark which is the maximun number of commands we could
-     *       pipeline without kill redis performance.
      */
+    // @TODO we need to benchmark which is the maximun number of commands we could pipeline without kill redis performance.
     SplitsCacheInRedis.prototype.getAll = function () {
         var _this = this;
         return this.redis.keys(this.keys.searchPatternForSplitKeys())

package/cjs/storages/inRedis/TelemetryCacheInRedis.js

@@ -10,9 +10,9 @@ var utils_1 = require("../utils");
 var TelemetryCacheInRedis = /** @class */ (function () {
     /**
      * Create a Telemetry cache that uses Redis as storage.
-     * @param log  Logger instance.
-     * @param keys  Key builder.
-     * @param redis  Redis client.
+     * @param log -  Logger instance.
+     * @param keys -  Key builder.
+     * @param redis -  Redis client.
      */
     function TelemetryCacheInRedis(log, keys, redis) {
         this.log = log;

package/cjs/storages/inRedis/UniqueKeysCacheInRedis.js

@@ -54,7 +54,7 @@ var UniqueKeysCacheInRedis = /** @class */ (function (_super) {
     };
     /**
      * Async consumer API, used by synchronizer.
-     * @param count number of items to pop from the queue. If not provided or equal 0, all items will be popped.
+     * @param count - number of items to pop from the queue. If not provided or equal 0, all items will be popped.
      */
     UniqueKeysCacheInRedis.prototype.popNRaw = function (count) {
         var _this = this;

package/cjs/storages/pluggable/EventsCachePluggable.js

@@ -11,7 +11,7 @@ var EventsCachePluggable = /** @class */ (function () {
     }
     /**
      * Push given event to the storage.
-     * @param eventData  Event item to push.
+     * @param eventData -  Event item to push.
      * @returns  A promise that is resolved with a boolean value indicating if the push operation succeeded or failed.
      * Unlike `impressions::track`, The promise will never be rejected.
      */

package/cjs/storages/pluggable/ImpressionsCachePluggable.js

@@ -11,7 +11,7 @@ var ImpressionsCachePluggable = /** @class */ (function () {
     }
     /**
      * Push given impressions to the storage.
-     * @param impressions  List of impresions to push.
+     * @param impressions -  List of impresions to push.
      * @returns  A promise that is resolved if the push operation succeeded
      * or rejected if the wrapper operation fails.
      */

package/cjs/storages/pluggable/SegmentsCachePluggable.js

@@ -71,7 +71,7 @@ var SegmentsCachePluggable = /** @class */ (function () {
     SegmentsCachePluggable.prototype.getRegisteredSegments = function () {
         return this.wrapper.getItems(this.keys.buildRegisteredSegmentsKey());
     };
-    /** @TODO implement if required by DataLoader or Producer mode  */
+    // @TODO implement if required by DataLoader or Producer mode
     SegmentsCachePluggable.prototype.clear = function () {
         return Promise.resolve(true);
     };

package/cjs/storages/pluggable/SplitsCachePluggable.js

@@ -13,9 +13,9 @@ var SplitsCachePluggable = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(SplitsCachePluggable, _super);
     /**
      * Create a SplitsCache that uses a storage wrapper.
-     * @param log  Logger instance.
-     * @param keys  Key builder.
-     * @param wrapper  Adapted wrapper storage.
+     * @param log -  Logger instance.
+     * @param keys -  Key builder.
+     * @param wrapper -  Adapted wrapper storage.
      */
     function SplitsCachePluggable(log, keys, wrapper, splitFiltersValidation) {
         var _this = _super.call(this) || this;

package/cjs/storages/pluggable/TelemetryCachePluggable.js

@@ -10,9 +10,9 @@ var utils_1 = require("../utils");
 var TelemetryCachePluggable = /** @class */ (function () {
     /**
      * Create a Telemetry cache that uses a storage wrapper.
-     * @param log  Logger instance.
-     * @param keys  Key builder.
-     * @param wrapper  Adapted wrapper storage.
+     * @param log -  Logger instance.
+     * @param keys -  Key builder.
+     * @param wrapper -  Adapted wrapper storage.
      */
     function TelemetryCachePluggable(log, keys, wrapper) {
         this.log = log;

package/cjs/storages/pluggable/UniqueKeysCachePluggable.js

@@ -48,7 +48,7 @@ var UniqueKeysCachePluggable = /** @class */ (function (_super) {
     };
     /**
      * Async consumer API, used by synchronizer.
-     * @param count number of items to pop from the queue. If not provided or equal 0, all items will be popped.
+     * @param count - number of items to pop from the queue. If not provided or equal 0, all items will be popped.
      */
     UniqueKeysCachePluggable.prototype.popNRaw = function (count) {
         var _this = this;

package/cjs/storages/pluggable/inMemoryWrapper.js

@@ -8,7 +8,7 @@ var sets_1 = require("../../utils/lang/sets");
  * The `_cache` property is the object were items are stored.
  * Intended for testing purposes.
  *
- * @param connDelay delay in millis for `connect` resolve. If not provided, `connect` resolves immediately.
+ * @param connDelay - delay in millis for `connect` resolve. If not provided, `connect` resolves immediately.
  */
 function inMemoryWrapperFactory(connDelay) {
     var _cache = {};

package/cjs/storages/pluggable/index.js

@@ -27,7 +27,7 @@ var NO_VALID_WRAPPER_INTERFACE = 'The provided wrapper instance doesn’t follow
 /**
  * Validate pluggable storage factory options.
  *
- * @param options user options
+ * @param options - user options
  * @throws Will throw an error if the options are invalid. Example: wrapper is not provided or doesn't have some methods.
  */
 function validatePluggableStorageOptions(options) {

package/cjs/storages/pluggable/wrapperAdapter.js

@@ -25,8 +25,8 @@ exports.METHODS_TO_PROMISE_WRAP = [
  * Adapter of the Pluggable Storage Wrapper.
  * Used to handle exceptions as rejected promises, in order to simplify the error handling on storages.
  *
- * @param log logger instance
- * @param wrapper storage wrapper to adapt
+ * @param log - logger instance
+ * @param wrapper - storage wrapper to adapt
  * @returns an adapted version of the given storage wrapper
  */
 function wrapperAdapter(log, wrapper) {

package/cjs/sync/offline/splitsParser/splitsParserFromSettings.js

@@ -33,7 +33,7 @@ function splitsParserFromSettingsFactory() {
     }
     /**
      *
-     * @param settings validated object with mocked features mapping.
+     * @param settings - validated object with mocked features mapping.
      */
     return function splitsParserFromSettings(settings) {
         var features = settings.features || {};

package/cjs/sync/offline/syncManagerOffline.js

@@ -11,7 +11,7 @@ function flush() {
  * Offline SyncManager factory.
  * Can be used for server-side API, and client-side API with or without multiple clients.
  *
- * @param splitsParser e.g., `splitsParserFromFile`, `splitsParserFromSettings`.
+ * @param splitsParser - e.g., `splitsParserFromFile`, `splitsParserFromSettings`.
  */
 function syncManagerOfflineFactory(splitsParserFactory) {
     /**

package/cjs/sync/polling/updaters/mySegmentsUpdater.js

@@ -66,12 +66,12 @@ function mySegmentsUpdaterFactory(log, mySegmentsFetcher, storage, segmentsEvent
      * MySegments updater returns a promise that resolves with a `false` boolean value if it fails to fetch mySegments or synchronize them with the storage.
      * Returned promise will not be rejected.
      *
-     * @param {SegmentsData | undefined} segmentsData it can be:
+     * @param segmentsData - it can be:
      *  (1) the list of mySegments names to sync in the storage,
      *  (2) an object with a segment name and action (true: add, or false: delete) to update the storage,
      *  (3) or `undefined`, for which the updater will fetch mySegments in order to sync the storage.
-     * @param {boolean | undefined} noCache true to revalidate data to fetch
-     * @param {boolean | undefined} till query param to bypass CDN requests
+     * @param noCache - true to revalidate data to fetch
+     * @param till - query param to bypass CDN requests
      */
     return function mySegmentsUpdater(segmentsData, noCache, till) {
         return _mySegmentsUpdater(0, segmentsData, noCache, till);