@splitsoftware/splitio 10.22.3 → 10.22.5-rc.0

package/types/splitio.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Javascript and NodeJS Split Software SDK
+// Type definitions for JavaScript and NodeJS Split Software SDK
 // Project: http://www.split.io/
 // Definitions by: Nico Zelaya <https://github.com/NicoZelaya/>
 
@@ -214,24 +214,24 @@ interface ISharedSettings {
    */
   sync?: {
     /**
-     * List of Split filters. These filters are used to fetch a subset of the Splits definitions in your environment, in order to reduce the delay of the SDK to be ready.
+     * List of feature flag filters. These filters are used to fetch a subset of the feature flag definitions in your environment, in order to reduce the delay of the SDK to be ready.
      * This configuration is only meaningful when the SDK is working in "standalone" mode.
      *
-     * At the moment, two types of split filters are supported: by name and by prefix.
+     * At the moment, only one type of feature flag filter is supported: by name.
+     *
      * Example:
      *  `splitFilter: [
-     *    { type: 'byName', values: ['my_split_1', 'my_split_2'] }, // will fetch splits named 'my_split_1' and 'my_split_2'
-     *    { type: 'byPrefix', values: ['testing'] } // will fetch splits whose names start with 'testing__' prefix
+     *    { type: 'byName', values: ['my_feature_flag_1', 'my_feature_flag_2'] }, // will fetch feature flags named 'my_feature_flag_1' and 'my_feature_flag_2'
      *  ]`
      * @property {SplitIO.SplitFilter[]} splitFilters
      */
     splitFilters?: SplitIO.SplitFilter[]
     /**
-     * Impressions Collection Mode. Option to determine how impressions are going to be sent to Split Servers.
+     * Impressions Collection Mode. Option to determine how impressions are going to be sent to Split servers.
      * Possible values are 'DEBUG', 'OPTIMIZED', and 'NONE'.
      * - DEBUG: will send all the impressions generated (recommended only for debugging purposes).
-     * - OPTIMIZED: will send unique impressions to Split Servers, avoiding a considerable amount of traffic that duplicated impressions could generate.
-     * - NONE: will send unique keys evaluated per feature to Split Servers instead of full blown impressions, avoiding a considerable amount of traffic that impressions could generate.
+     * - OPTIMIZED: will send unique impressions to Split servers, avoiding a considerable amount of traffic that duplicated impressions could generate.
+     * - NONE: will send unique keys evaluated per feature to Split servers instead of full blown impressions, avoiding a considerable amount of traffic that impressions could generate.
      *
      * @property {string} impressionsMode
      * @default 'OPTIMIZED'
@@ -293,7 +293,7 @@ interface INodeBasicSettings extends ISharedSettings {
    */
   scheduler?: {
     /**
-     * The SDK polls Split servers for changes to feature roll-out plans. This parameter controls this polling period in seconds.
+     * The SDK polls Split servers for changes to feature flag definitions. This parameter controls this polling period in seconds.
      * @property {number} featuresRefreshRate
      * @default 60
      */
@@ -364,7 +364,7 @@ interface INodeBasicSettings extends ISharedSettings {
    */
   core: {
     /**
-     * Your API key. More information: @see {@link https://help.split.io/hc/en-us/articles/360019916211-API-keys}
+     * Your SDK key. More information: @see {@link https://help.split.io/hc/en-us/articles/360019916211-API-keys}
      * @property {string} authorizationKey
      */
     authorizationKey: string,
@@ -389,7 +389,7 @@ interface INodeBasicSettings extends ISharedSettings {
     /**
      * Storage type to be instantiated by the SDK.
      * @property {StorageType} type
-     * @default MEMORY
+     * @default 'MEMORY'
      */
     type?: StorageType,
     /**
@@ -400,7 +400,7 @@ interface INodeBasicSettings extends ISharedSettings {
     /**
      * Optional prefix to prevent any kind of data collision between SDK versions.
      * @property {string} prefix
-     * @default SPLITIO
+     * @default 'SPLITIO'
      */
     prefix?: string
   },
@@ -408,14 +408,14 @@ interface INodeBasicSettings extends ISharedSettings {
    * The SDK mode. Possible values are "standalone", which is the default when using a synchronous storage, like 'MEMORY' and 'LOCALSTORAGE',
    * and "consumer", which must be set when using an asynchronous storage, like 'REDIS'. For "localhost" mode, use "localhost" as authorizationKey.
    * @property {SDKMode} mode
-   * @default standalone
+   * @default 'standalone'
    */
   mode?: SDKMode,
   /**
    * Mocked features file path. For testing purposses only. For using this you should specify "localhost" as authorizationKey on core settings.
    * @see {@link https://help.split.io/hc/en-us/articles/360020564931-Node-js-SDK#localhost-mode}
    * @property {MockedFeaturesFilePath} features
-   * @default $HOME/.split
+   * @default '$HOME/.split'
    */
   features?: SplitIO.MockedFeaturesFilePath,
 }
@@ -431,7 +431,7 @@ interface IStatusInterface extends EventEmitter {
    */
   Event: EventConsts,
   /**
-   * 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).
+   * Returns a promise that resolves 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.
    *
@@ -458,9 +458,12 @@ interface IStatusInterface extends EventEmitter {
  */
 interface IBasicClient extends IStatusInterface {
   /**
-   * Destroy the client instance.
+   * Destroys the client instance.
+   * In 'standalone' mode, this method will flush any pending impressions and events, and stop the synchronization of feature flag definitions with the backend.
+   * In 'consumer' mode, this method will disconnect the SDK from the Redis or Pluggable storage.
+   *
    * @function destroy
-   * @returns {Promise<void>}
+   * @returns {Promise<void>} A promise that resolves once the client is destroyed.
    */
   destroy(): Promise<void>
 }
@@ -488,17 +491,17 @@ interface IBasicSDK {
  */
 declare namespace SplitIO {
   /**
-   * Split treatment value, returned by getTreatment.
+   * Feature flag treatment value, returned by getTreatment.
    * @typedef {string} Treatment
    */
   type Treatment = string;
   /**
-   * Split treatment promise that will resolve to actual treatment value.
+   * Feature flag treatment promise that resolves to actual treatment value.
    * @typedef {Promise<string>} AsyncTreatment
    */
   type AsyncTreatment = Promise<string>;
   /**
-   * An object with the treatments for a bulk of splits, returned by getTreatments. For example:
+   * An object with the treatments for a bulk of feature flags, returned by getTreatments. For example:
    *   {
    *     feature1: 'on',
    *     feature2: 'off
@@ -509,14 +512,14 @@ declare namespace SplitIO {
     [featureName: string]: Treatment
   };
   /**
-   * Split treatments promise that will resolve to the actual SplitIO.Treatments object.
+   * Feature flag treatments promise that resolves to the actual SplitIO.Treatments object.
    * @typedef {Promise<Treatments>} AsyncTreatments
    */
   type AsyncTreatments = Promise<Treatments>;
   /**
-   * Split evaluation result with treatment and configuration, returned by getTreatmentWithConfig.
+   * Feature flag evaluation result with treatment and configuration, returned by getTreatmentWithConfig.
    * @typedef {Object} TreatmentWithConfig
-   * @property {string} treatment The treatment result
+   * @property {string} treatment The treatment string
    * @property {string | null} config The stringified version of the JSON config defined for that treatment, null if there is no config for the resulting treatment.
    */
   type TreatmentWithConfig = {
@@ -524,13 +527,13 @@ declare namespace SplitIO {
     config: string | null
   };
   /**
-   * Split treatment promise that will resolve to actual treatment with config value.
+   * Feature flag treatment promise that resolves to actual treatment with config value.
    * @typedef {Promise<TreatmentWithConfig>} AsyncTreatmentWithConfig
    */
   type AsyncTreatmentWithConfig = Promise<TreatmentWithConfig>;
   /**
-   * An object with the treatments with configs for a bulk of splits, returned by getTreatmentsWithConfig.
-   * Each existing configuration is a stringified version of the JSON you defined on the Split web console. For example:
+   * An object with the treatments with configs for a bulk of feature flags, returned by getTreatmentsWithConfig.
+   * Each existing configuration is a stringified version of the JSON you defined on the Split user interface. For example:
    *   {
    *     feature1: { treatment: 'on', config: null }
    *     feature2: { treatment: 'off', config: '{"bannerText":"Click here."}' }
@@ -541,7 +544,7 @@ declare namespace SplitIO {
     [featureName: string]: TreatmentWithConfig
   };
   /**
-   * Split treatments promise that will resolve to the actual SplitIO.TreatmentsWithConfig object.
+   * Feature flag treatments promise that resolves to the actual SplitIO.TreatmentsWithConfig object.
    * @typedef {Promise<TreatmentsWithConfig>} AsyncTreatmentsWithConfig
    */
   type AsyncTreatmentsWithConfig = Promise<TreatmentsWithConfig>;
@@ -551,7 +554,7 @@ declare namespace SplitIO {
    */
   type Event = 'init::timeout' | 'init::ready' | 'init::cache-ready' | 'state::update';
   /**
-   * Split 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.
+   * 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.
    * @typedef {Object.<AttributeType>} Attributes
    * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#attribute-syntax}
    */
@@ -564,7 +567,7 @@ declare namespace SplitIO {
    */
   type AttributeType = string | number | boolean | Array<string | number>;
   /**
-   * Split properties should be an object with values of type string, number, boolean or null. Size limit of ~31kb.
+   * Properties should be an object with values of type string, number, boolean or null. Size limit of ~31kb.
    * @typedef {Object.<number, string, boolean, null>} Properties
    * @see {@link https://help.split.io/hc/en-us/articles/360020448791-JavaScript-SDK#track
    */
@@ -618,38 +621,38 @@ declare namespace SplitIO {
     sdkLanguageVersion: string
   };
   /**
-   * Data corresponding to one Split view.
+   * Data corresponding to one feature flag view.
    * @typedef {Object} SplitView
    */
   type SplitView = {
     /**
-     * The name of the split.
+     * The name of the feature flag.
      * @property {string} name
      */
     name: string,
     /**
-     * The traffic type of the split.
+     * The traffic type of the feature flag.
      * @property {string} trafficType
      */
     trafficType: string,
     /**
-     * Whether the split is killed or not.
+     * Whether the feature flag is killed or not.
      * @property {boolean} killed
      */
     killed: boolean,
     /**
-     * The list of treatments available for the split.
+     * The list of treatments available for the feature flag.
      * @property {Array<string>} treatments
      */
     treatments: Array<string>,
     /**
-     * Current change number of the split.
+     * Current change number of the feature flag.
      * @property {number} changeNumber
      */
     changeNumber: number,
     /**
      * Map of configurations per treatment.
-     * Each existing configuration is a stringified version of the JSON you defined on the Split web console.
+     * Each existing configuration is a stringified version of the JSON you defined on the Split user interface.
      * @property {Object.<string>} configs
      */
     configs: {
@@ -657,7 +660,7 @@ declare namespace SplitIO {
     }
   };
   /**
-   * A promise that will be resolved with that SplitView.
+   * A promise that resolves to a feature flag view.
    * @typedef {Promise<SplitView>} SplitView
    */
   type SplitViewAsync = Promise<SplitView>;
@@ -666,17 +669,17 @@ declare namespace SplitIO {
    */
   type SplitViews = Array<SplitView>;
   /**
-   * A promise that will be resolved with an SplitIO.SplitViews array.
+   * A promise that resolves to an SplitIO.SplitViews array.
    * @typedef {Promise<SplitViews>} SplitViewsAsync
    */
   type SplitViewsAsync = Promise<SplitViews>;
   /**
-   * An array of split names.
+   * An array of feature flag names.
    * @typedef {Array<string>} SplitNames
    */
   type SplitNames = Array<string>;
   /**
-   * A promise that will be resolved with an array of split names.
+   * A promise that resolves to an array of feature flag names.
    * @typedef {Promise<SplitNames>} SplitNamesAsync
    */
   type SplitNamesAsync = Promise<SplitNames>;
@@ -857,7 +860,7 @@ declare namespace SplitIO {
    */
   type UrlSettings = {
     /**
-     * String property to override the base URL where the SDK will get feature flagging related data like a Split rollout plan or segments information.
+     * String property to override the base URL where the SDK will get rollout plan related data, like feature flags and segments definitions.
      * @property {string} sdk
      * @default 'https://sdk.split.io/api'
      */
@@ -894,20 +897,23 @@ declare namespace SplitIO {
   type BrowserIntegration = ISplitToGoogleAnalyticsConfig | IGoogleAnalyticsToSplitConfig;
   /**
    * SplitFilter type.
+   *
    * @typedef {string} SplitFilterType
    */
   type SplitFilterType = 'byName' | 'byPrefix';
   /**
-   * Defines a split filter, described by a type and list of values.
+   * Defines a feature flag filter, described by a type and list of values.
    */
   interface SplitFilter {
     /**
      * Type of the filter.
+     *
      * @property {SplitFilterType} type
      */
     type: SplitFilterType,
     /**
-     * List of values: split names for 'byName' filter type, and split prefixes for 'byPrefix' type.
+     * List of values: feature flag names for 'byName' filter type, and feature flag name prefixes for 'byPrefix' type.
+     *
      * @property {string[]} values
      */
     values: string[],
@@ -967,7 +973,7 @@ declare namespace SplitIO {
      */
     scheduler?: {
       /**
-       * The SDK polls Split servers for changes to feature roll-out plans. This parameter controls this polling period in seconds.
+       * The SDK polls Split servers for changes to feature flag definitions. This parameter controls this polling period in seconds.
        * @property {number} featuresRefreshRate
        * @default 60
        */
@@ -1038,7 +1044,7 @@ declare namespace SplitIO {
      */
     core: {
       /**
-       * Your API key. More information: @see {@link https://help.split.io/hc/en-us/articles/360019916211-API-keys}
+       * Your SDK key. More information: @see {@link https://help.split.io/hc/en-us/articles/360019916211-API-keys}
        * @property {string} authorizationKey
        */
       authorizationKey: string,
@@ -1074,13 +1080,13 @@ declare namespace SplitIO {
       /**
        * Storage type to be instantiated by the SDK.
        * @property {BrowserStorage} type
-       * @default MEMORY
+       * @default 'MEMORY'
        */
       type?: BrowserStorage,
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.
        * @property {string} prefix
-       * @default SPLITIO
+       * @default 'SPLITIO'
        */
       prefix?: string
     },
@@ -1130,13 +1136,13 @@ declare namespace SplitIO {
       /**
        * Synchronous storage type to be instantiated by the SDK.
        * @property {NodeSyncStorage} type
-       * @default MEMORY
+       * @default 'MEMORY'
        */
       type?: NodeSyncStorage,
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.
        * @property {string} prefix
-       * @default SPLITIO
+       * @default 'SPLITIO'
        */
       prefix?: string
     },
@@ -1145,7 +1151,7 @@ declare namespace SplitIO {
      * For "localhost" mode, use "localhost" as authorizationKey.
      *
      * @property {'standalone'} mode
-     * @default standalone
+     * @default 'standalone'
      */
     mode?: 'standalone'
   }
@@ -1234,7 +1240,7 @@ declare namespace SplitIO {
       /**
        * Optional prefix to prevent any kind of data collision between SDK versions.
        * @property {string} prefix
-       * @default SPLITIO
+       * @default 'SPLITIO'
        */
       prefix?: string
     },
@@ -1330,83 +1336,83 @@ declare namespace SplitIO {
      * For usage on NodeJS as we don't have only one key.
      * @function getTreatment
      * @param {string} key - The string key representing the consumer.
-     * @param {string} splitName - The string that represents the split we wan't to get the treatment.
+     * @param {string} featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {Treatment} The treatment string.
      */
-    getTreatment(key: SplitKey, splitName: string, attributes?: Attributes): Treatment,
+    getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes): Treatment,
     /**
      * Returns a Treatment value, which is the treatment string for the given feature.
      * For usage on the Browser as we defined the key on the settings.
      * @function getTreatment
-     * @param {string} splitName - The string that represents the split we wan't to get the treatment.
+     * @param {string} featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {Treatment} The treatment string.
      */
-    getTreatment(splitName: string, attributes?: Attributes): Treatment,
+    getTreatment(featureFlagName: string, attributes?: Attributes): Treatment,
     /**
      * Returns a TreatmentWithConfig value, which is an object with both treatment and config string for the given feature.
      * For usage on NodeJS as we don't have only one key.
      * @function getTreatmentWithConfig
      * @param {string} key - The string key representing the consumer.
-     * @param {string} splitName - The string that represents the split we wan't to get the treatment.
+     * @param {string} featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {TreatmentWithConfig} The TreatmentWithConfig, the object containing the treatment string and the
      *                                configuration stringified JSON (or null if there was no config for that treatment).
      */
-    getTreatmentWithConfig(key: SplitKey, splitName: string, attributes?: Attributes): TreatmentWithConfig,
+    getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes): TreatmentWithConfig,
     /**
      * Returns a TreatmentWithConfig value, which an object with both treatment and config string for the given feature.
      * For usage on the Browser as we defined the key on the settings.
      * @function getTreatment
-     * @param {string} splitName - The string that represents the split we wan't to get the treatment.
+     * @param {string} featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {TreatmentWithConfig} The TreatmentWithConfig, the object containing the treatment string and the
      *                                configuration stringified JSON (or null if there was no config for that treatment).
      */
-    getTreatmentWithConfig(splitName: string, attributes?: Attributes): TreatmentWithConfig,
+    getTreatmentWithConfig(featureFlagName: string, attributes?: Attributes): TreatmentWithConfig,
     /**
      * Returns a Treatments value, which is an object map with the treatments for the given features.
      * For usage on NodeJS as we don't have only one key.
      * NOTE: Treatment will be a promise only in async storages, like REDIS.
      * @function getTreatments
      * @param {string} key - The string key representing the consumer.
-     * @param {Array<string>} splitNames - An array of the split names we wan't to get the treatments.
+     * @param {Array<string>} featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {Treatments} The treatments object map.
      */
-    getTreatments(key: SplitKey, splitNames: string[], attributes?: Attributes): Treatments,
+    getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): Treatments,
     /**
      * Returns a Treatments value, which is an object map with the treatments for the given features.
      * For usage on the Browser as we defined the key on the settings.
      * NOTE: Treatment will be a promise only in async storages, like REDIS.
      * @function getTreatments
-     * @param {Array<string>} splitNames - An array of the split names we wan't to get the treatments.
+     * @param {Array<string>} featureFlagNames - An array of the feature flags names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {Treatments} The treatments object map.
      */
-    getTreatments(splitNames: string[], attributes?: Attributes): Treatments,
+    getTreatments(featureFlagNames: string[], attributes?: Attributes): Treatments,
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the given features.
      * For usage on NodeJS as we don't have only one key.
      * @function getTreatmentsWithConfig
      * @param {string} key - The string key representing the consumer.
-     * @param {Array<string>} splitNames - An array of the split names we wan't to get the treatments.
+     * @param {Array<string>} featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {TreatmentsWithConfig} The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfig(key: SplitKey, splitNames: string[], attributes?: Attributes): TreatmentsWithConfig,
+    getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): TreatmentsWithConfig,
     /**
      * Returns a TreatmentsWithConfig value, which is an object map with the TreatmentWithConfig (an object with both treatment and config string) for the given features.
      * For usage on the Browser as we defined the key on the settings.
      * @function getTreatmentsWithConfig
-     * @param {Array<string>} splitNames - An array of the split names we wan't to get the treatments.
+     * @param {Array<string>} featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
      * @returns {TreatmentsWithConfig} The map with all the TreatmentWithConfig objects
      */
-    getTreatmentsWithConfig(splitNames: string[], attributes?: Attributes): TreatmentsWithConfig,
+    getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes): TreatmentsWithConfig,
     /**
-     * Tracks an event to be fed to the results product on Split Webconsole.
+     * Tracks an event to be fed to the results product on Split user interface.
      * For usage on NodeJS as we don't have only one key.
      * @function track
      * @param {SplitKey} key - The key that identifies the entity related to this event.
@@ -1418,7 +1424,7 @@ declare namespace SplitIO {
      */
     track(key: SplitIO.SplitKey, trafficType: string, eventType: string, value?: number, properties?: Properties): boolean,
     /**
-     * Tracks an event to be fed to the results product on Split Webconsole.
+     * Tracks an event to be fed to the results product on Split user interface.
      * For usage on the Browser as we defined the key on the settings.
      * @function track
      * @param {string} trafficType - The traffic type of the entity related to this event.
@@ -1429,7 +1435,7 @@ declare namespace SplitIO {
      */
     track(trafficType: string, eventType: string, value?: number, properties?: Properties): boolean,
     /**
-     * Tracks an event to be fed to the results product on Split Webconsole.
+     * Tracks an event to be fed to the results product on Split user interface.
      * For usage on the Browser if we defined the key and also the trafficType on the settings.
      * @function track
      * @param {string} eventType - The event type corresponding to this event.
@@ -1499,44 +1505,44 @@ declare namespace SplitIO {
      * NOTE: Treatment will be a promise only in async storages, like REDIS.
      * @function getTreatment
      * @param {string} key - The string key representing the consumer.
-     * @param {string} splitName - The string that represents the split we wan't to get the treatment.
+     * @param {string} featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns {AsyncTreatment} Treatment promise which will resolve to the treatment string.
+     * @returns {AsyncTreatment} Treatment promise that resolves to the treatment string.
      */
-    getTreatment(key: SplitKey, splitName: string, attributes?: Attributes): AsyncTreatment,
+    getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes): AsyncTreatment,
     /**
      * Returns a TreatmentWithConfig value, which will be (or eventually be) an object with both treatment and config string for the given feature.
      * For usage on NodeJS as we don't have only one key.
      * NOTE: Treatment will be a promise only in async storages, like REDIS.
      * @function getTreatmentWithConfig
      * @param {string} key - The string key representing the consumer.
-     * @param {string} splitName - The string that represents the split we wan't to get the treatment.
+     * @param {string} featureFlagName - The string that represents the feature flag we want to get the treatment.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns {AsyncTreatmentWithConfig} TreatmentWithConfig promise which will resolve to the TreatmentWithConfig object.
+     * @returns {AsyncTreatmentWithConfig} TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
      */
-    getTreatmentWithConfig(key: SplitKey, splitName: string, attributes?: Attributes): AsyncTreatmentWithConfig,
+    getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes): AsyncTreatmentWithConfig,
     /**
      * Returns a Treatments value, which will be (or eventually be) an object map with the treatments for the given features.
      * For usage on NodeJS as we don't have only one key.
      * @function getTreatments
      * @param {string} key - The string key representing the consumer.
-     * @param {Array<string>} splitNames - An array of the split names we wan't to get the treatments.
+     * @param {Array<string>} featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns {AsyncTreatments} Treatments promise which will resolve to the treatments object map.
+     * @returns {AsyncTreatments} Treatments promise that resolves to the treatments object map.
      */
-    getTreatments(key: SplitKey, splitNames: string[], attributes?: Attributes): AsyncTreatments,
+    getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): AsyncTreatments,
     /**
      * Returns a TreatmentsWithConfig value, which will be (or eventually be) an object map with the TreatmentWithConfig (an object with both treatment and config string) for the given features.
      * For usage on NodeJS as we don't have only one key.
      * @function getTreatmentsWithConfig
      * @param {string} key - The string key representing the consumer.
-     * @param {Array<string>} splitNames - An array of the split names we wan't to get the treatments.
+     * @param {Array<string>} featureFlagNames - An array of the feature flag names we want to get the treatments.
      * @param {Attributes=} attributes - An object of type Attributes defining the attributes for the given key.
-     * @returns {AsyncTreatmentsWithConfig} TreatmentsWithConfig promise which will resolve to the map of TreatmentsWithConfig objects.
+     * @returns {AsyncTreatmentsWithConfig} TreatmentsWithConfig promise that resolves to the map of TreatmentsWithConfig objects.
      */
-    getTreatmentsWithConfig(key: SplitKey, splitNames: string[], attributes?: Attributes): AsyncTreatmentsWithConfig,
+    getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes): AsyncTreatmentsWithConfig,
     /**
-     * Tracks an event to be fed to the results product on Split Webconsole and returns a promise to signal when the event was successfully queued (or not).
+     * 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).
      * @function track
      * @param {SplitKey} key - The key that identifies the entity related to this event.
      * @param {string} trafficType - The traffic type of the entity related to this event.
@@ -1554,24 +1560,24 @@ declare namespace SplitIO {
    */
   interface IManager extends IStatusInterface {
     /**
-     * Get the array of Split names.
+     * Get the array of feature flag names.
      * @function names
-     * @returns {SplitNames} The lists of Split names.
+     * @returns {SplitNames} The list of feature flag names.
      */
     names(): SplitNames;
     /**
-     * Get the array of splits data in SplitView format.
+     * Get the array of feature flags data in SplitView format.
      * @function splits
      * @returns {SplitViews} The list of SplitIO.SplitView.
      */
     splits(): SplitViews;
     /**
-     * Get the data of a split in SplitView format.
+     * Get the data of a feature flag in SplitView format.
      * @function split
-     * @param {string} splitName The name of the split we wan't to get info of.
-     * @returns {SplitView | null} The SplitIO.SplitView of the given split or null if the split is not found.
+     * @param {string} featureFlagName The name of the feature flag we want to get info of.
+     * @returns {SplitView | null} The SplitIO.SplitView of the given feature flag name or null if the feature flag is not found.
      */
-    split(splitName: string): SplitView | null;
+    split(featureFlagName: string): SplitView | null;
   }
   /**
    * Representation of a manager instance with asynchronous storage of the SDK.
@@ -1580,23 +1586,23 @@ declare namespace SplitIO {
    */
   interface IAsyncManager extends IStatusInterface {
     /**
-     * Get the array of Split names.
+     * Get the array of feature flag names.
      * @function names
-     * @returns {SplitNamesAsync} A promise that will resolve to the array of Splitio.SplitNames.
+     * @returns {SplitNamesAsync} A promise that resolves to the list of feature flag names.
      */
     names(): SplitNamesAsync;
     /**
-     * Get the array of splits data in SplitView format.
+     * Get the array of feature flags data in SplitView format.
      * @function splits
-     * @returns {SplitViewsAsync} A promise that will resolve to the SplitIO.SplitView list.
+     * @returns {SplitViewsAsync} A promise that resolves to the SplitIO.SplitView list.
      */
     splits(): SplitViewsAsync;
     /**
-     * Get the data of a split in SplitView format.
+     * Get the data of a feature flag in SplitView format.
      * @function split
-     * @param {string} splitName The name of the split we wan't to get info of.
-     * @returns {SplitViewAsync} A promise that will resolve to the SplitIO.SplitView value.
+     * @param {string} featureFlagName The name of the feature flag we want to get info of.
+     * @returns {SplitViewAsync} A promise that resolves to the SplitIO.SplitView value.
      */
-    split(splitName: string): SplitViewAsync;
+    split(featureFlagName: string): SplitViewAsync;
   }
 }