Skip to content

Commit 5ae4013

Browse files
docs: add JSDoc comments for fallback treatment configuration types
1 parent a629592 commit 5ae4013

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

types/splitio.d.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,8 @@ interface ISharedSettings {
9898
logger?: SplitIO.Logger;
9999
/**
100100
* Fallback treatments to be used when the SDK is not ready or the flag is not found.
101+
*
102+
* @defaultValue `undefined`
101103
*/
102104
fallbackTreatments?: SplitIO.FallbackTreatmentConfiguration;
103105
}
@@ -1307,7 +1309,13 @@ declare namespace SplitIO {
13071309
* Fallback treatments to be used when the SDK is not ready or the flag is not found.
13081310
*/
13091311
type FallbackTreatmentConfiguration = {
1312+
/**
1313+
* Fallback treatment for all flags.
1314+
*/
13101315
global?: Treatment | TreatmentWithConfig,
1316+
/**
1317+
* Fallback treatments for specific flags. It takes precedence over the global fallback treatment.
1318+
*/
13111319
byFlag?: {
13121320
[featureFlagName: string]: Treatment | TreatmentWithConfig
13131321
}

0 commit comments

Comments
 (0)