@splitsoftware/splitio-commons 3.0.0-rc.5 → 3.0.0-rc.6
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/package.json +1 -1
- package/types/splitio.d.ts +2 -29
package/package.json
CHANGED
package/types/splitio.d.ts
CHANGED
|
@@ -2315,7 +2315,7 @@ declare namespace SplitIO {
|
|
|
2315
2315
|
*
|
|
2316
2316
|
* @see {@link https://developer.harness.io/docs/feature-management-experimentation/management-and-administration/account-settings/api-keys/}
|
|
2317
2317
|
*/
|
|
2318
|
-
|
|
2318
|
+
sdkKey: string;
|
|
2319
2319
|
/**
|
|
2320
2320
|
* Polling rate for configs and segments refresh, in seconds. Minimum value: 5.
|
|
2321
2321
|
*
|
|
@@ -2379,33 +2379,6 @@ declare namespace SplitIO {
|
|
|
2379
2379
|
* If provided, this object is merged with the options object passed by the SDK for EventSource and Fetch calls.
|
|
2380
2380
|
*/
|
|
2381
2381
|
requestOptions?: {
|
|
2382
|
-
/**
|
|
2383
|
-
* Custom function called before each request, allowing you to add or update headers in SDK HTTP requests.
|
|
2384
|
-
* Some headers, such as `SplitSDKVersion`, are required by the SDK and cannot be overridden.
|
|
2385
|
-
* To pass multiple headers with the same name, combine their values into a single line, separated by commas. Example: `{ 'Authorization': 'value1, value2' }`
|
|
2386
|
-
* Or provide keys with different cases since headers are case-insensitive. Example: `{ 'authorization': 'value1', 'Authorization': 'value2' }`
|
|
2387
|
-
*
|
|
2388
|
-
* @defaultValue `undefined`
|
|
2389
|
-
*
|
|
2390
|
-
* @param context - The context for the request, which contains the `headers` property object representing the current headers in the request.
|
|
2391
|
-
* @returns An object representing a set of headers to be merged with the current headers.
|
|
2392
|
-
*
|
|
2393
|
-
* @example
|
|
2394
|
-
* ```
|
|
2395
|
-
* const client = ConfigsClient({
|
|
2396
|
-
* ...
|
|
2397
|
-
* requestOptions: {
|
|
2398
|
-
* getHeaderOverrides: (context) => {
|
|
2399
|
-
* return {
|
|
2400
|
-
* 'Authorization': context.headers['Authorization'] + ', other-value',
|
|
2401
|
-
* 'custom-header': 'custom-value'
|
|
2402
|
-
* };
|
|
2403
|
-
* }
|
|
2404
|
-
* }
|
|
2405
|
-
* });
|
|
2406
|
-
* ```
|
|
2407
|
-
*/
|
|
2408
|
-
getHeaderOverrides?: (context: { headers: Record<string, string>; }) => Record<string, string>;
|
|
2409
2382
|
/**
|
|
2410
2383
|
* Custom Node.js HTTP(S) Agent used by the SDK for HTTP(S) requests.
|
|
2411
2384
|
*
|
|
@@ -2469,7 +2442,7 @@ declare namespace SplitIO {
|
|
|
2469
2442
|
/**
|
|
2470
2443
|
* Configs SDK client interface.
|
|
2471
2444
|
*/
|
|
2472
|
-
interface ConfigsClient extends Omit<IStatusInterface, 'ready'> {
|
|
2445
|
+
interface ConfigsClient extends Omit<IStatusInterface, 'ready' | 'whenReadyFromCache'> {
|
|
2473
2446
|
/**
|
|
2474
2447
|
* Destroys the client.
|
|
2475
2448
|
*
|