Type definitions

Author: EmilianoSanchez

ts-tests/index.ts

@@ -565,7 +565,10 @@ let fullBrowserSettings: SplitIO.IBrowserSettings = {
   sync: {
     splitFilters: splitFilters,
     impressionsMode: 'DEBUG',
-    enabled: true
+    enabled: true,
+    requestOptions: {
+      getHeaderOverrides() { return { 'header': 'value' } },
+    }
   },
   userConsent: 'GRANTED'
 };
@@ -618,6 +621,7 @@ let fullNodeSettings: SplitIO.INodeSettings = {
     impressionsMode: 'OPTIMIZED',
     enabled: true,
     requestOptions: {
+      getHeaderOverrides() { return { 'header': 'value' } },
       agent: new (require('https')).Agent(),
     }
   }
@@ -666,7 +670,7 @@ let fullAsyncSettings: SplitIO.INodeAsyncSettings = {
   mode: 'consumer',
   debug: true,
   sync: {
-    splitFilters: splitFilters
+    splitFilters: splitFilters,
   }
 };
 

types/splitio.d.ts

@@ -1126,7 +1126,25 @@ declare namespace SplitIO {
      * @typedef {string} userConsent
      * @default 'GRANTED'
      */
-    userConsent?: ConsentStatus
+    userConsent?: ConsentStatus,
+    sync?: ISharedSettings['sync'] & {
+      /**
+       * Custom options object for HTTP(S) requests in the Browser.
+       * If provided, this object is merged with the options object passed by the SDK for EventSource and Fetch calls.
+       * @see {@link https://www.npmjs.com/package/node-fetch#options}
+       */
+      requestOptions?: {
+        /**
+         * Custom function called before each request, allowing you to add or update custom headers on the SDK requests.
+         *
+         * @TODO pass context to `getHeaderOverrides`. Add `validUntil` property?
+         *
+         * @property getHeaderOverrides
+         * @default undefined
+         */
+        getHeaderOverrides?: () => Record<string, string>,
+      },
+    }
   }
   /**
    * Settings interface for SDK instances created on NodeJS.
@@ -1176,6 +1194,15 @@ declare namespace SplitIO {
        * @see {@link https://www.npmjs.com/package/node-fetch#options}
        */
       requestOptions?: {
+        /**
+         * Custom function called before each request, allowing you to add or update custom headers on the SDK requests.
+         *
+         * @TODO pass context to `getHeaderOverrides`. Add `validUntil` property?
+         *
+         * @property getHeaderOverrides
+         * @default undefined
+         */
+        getHeaderOverrides?: () => Record<string, string>,
         /**
          * Custom NodeJS HTTP(S) Agent used by the SDK for HTTP(S) requests.
          *