Skip to content

Commit d66c7fc

Browse files
Update type definitions
1 parent ad36a0f commit d66c7fc

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

types/splitio.d.ts

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1548,6 +1548,7 @@ declare namespace SplitIO {
15481548
* @param key - The string key representing the consumer.
15491549
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
15501550
* @param attributes - An object of type Attributes defining the attributes for the given key.
1551+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
15511552
* @returns The treatment string.
15521553
*/
15531554
getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): Treatment;
@@ -1557,8 +1558,8 @@ declare namespace SplitIO {
15571558
* @param key - The string key representing the consumer.
15581559
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
15591560
* @param attributes - An object of type Attributes defining the attributes for the given key.
1560-
* @returns The TreatmentWithConfig, the object containing the treatment string and the
1561-
* configuration stringified JSON (or null if there was no config for that treatment).
1561+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
1562+
* @returns The TreatmentWithConfig object that contains the treatment string and the configuration stringified JSON (or null if there was no config for that treatment).
15621563
*/
15631564
getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentWithConfig;
15641565
/**
@@ -1567,6 +1568,7 @@ declare namespace SplitIO {
15671568
* @param key - The string key representing the consumer.
15681569
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
15691570
* @param attributes - An object of type Attributes defining the attributes for the given key.
1571+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
15701572
* @returns The treatments object map.
15711573
*/
15721574
getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
@@ -1576,6 +1578,7 @@ declare namespace SplitIO {
15761578
* @param key - The string key representing the consumer.
15771579
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
15781580
* @param attributes - An object of type Attributes defining the attributes for the given key.
1581+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
15791582
* @returns The map with all the TreatmentWithConfig objects
15801583
*/
15811584
getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
@@ -1585,6 +1588,7 @@ declare namespace SplitIO {
15851588
* @param key - The string key representing the consumer.
15861589
* @param flagSet - The flag set name we want to get the treatments.
15871590
* @param attributes - An object of type Attributes defining the attributes for the given key.
1591+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
15881592
* @returns The map with all the Treatment objects
15891593
*/
15901594
getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): Treatments;
@@ -1594,6 +1598,7 @@ declare namespace SplitIO {
15941598
* @param key - The string key representing the consumer.
15951599
* @param flagSet - The flag set name we want to get the treatments.
15961600
* @param attributes - An object of type Attributes defining the attributes for the given key.
1601+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
15971602
* @returns The map with all the TreatmentWithConfig objects
15981603
*/
15991604
getTreatmentsWithConfigByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
@@ -1603,6 +1608,7 @@ declare namespace SplitIO {
16031608
* @param key - The string key representing the consumer.
16041609
* @param flagSets - An array of the flag set names we want to get the treatments.
16051610
* @param attributes - An object of type Attributes defining the attributes for the given key.
1611+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16061612
* @returns The map with all the Treatment objects
16071613
*/
16081614
getTreatmentsByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
@@ -1612,6 +1618,7 @@ declare namespace SplitIO {
16121618
* @param key - The string key representing the consumer.
16131619
* @param flagSets - An array of the flag set names we want to get the treatments.
16141620
* @param attributes - An object of type Attributes defining the attributes for the given key.
1621+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16151622
* @returns The map with all the TreatmentWithConfig objects
16161623
*/
16171624
getTreatmentsWithConfigByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
@@ -1639,6 +1646,7 @@ declare namespace SplitIO {
16391646
* @param key - The string key representing the consumer.
16401647
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
16411648
* @param attributes - An object of type Attributes defining the attributes for the given key.
1649+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16421650
* @returns Treatment promise that resolves to the treatment string.
16431651
*/
16441652
getTreatment(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatment;
@@ -1648,6 +1656,7 @@ declare namespace SplitIO {
16481656
* @param key - The string key representing the consumer.
16491657
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
16501658
* @param attributes - An object of type Attributes defining the attributes for the given key.
1659+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16511660
* @returns TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
16521661
*/
16531662
getTreatmentWithConfig(key: SplitKey, featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentWithConfig;
@@ -1657,6 +1666,7 @@ declare namespace SplitIO {
16571666
* @param key - The string key representing the consumer.
16581667
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
16591668
* @param attributes - An object of type Attributes defining the attributes for the given key.
1669+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16601670
* @returns Treatments promise that resolves to the treatments object map.
16611671
*/
16621672
getTreatments(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
@@ -1666,6 +1676,7 @@ declare namespace SplitIO {
16661676
* @param key - The string key representing the consumer.
16671677
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
16681678
* @param attributes - An object of type Attributes defining the attributes for the given key.
1679+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16691680
* @returns TreatmentsWithConfig promise that resolves to the map of TreatmentsWithConfig objects.
16701681
*/
16711682
getTreatmentsWithConfig(key: SplitKey, featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
@@ -1675,6 +1686,7 @@ declare namespace SplitIO {
16751686
* @param key - The string key representing the consumer.
16761687
* @param flagSet - The flag set name we want to get the treatments.
16771688
* @param attributes - An object of type Attributes defining the attributes for the given key.
1689+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16781690
* @returns Treatments promise that resolves to the treatments object map.
16791691
*/
16801692
getTreatmentsByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
@@ -1684,6 +1696,7 @@ declare namespace SplitIO {
16841696
* @param key - The string key representing the consumer.
16851697
* @param flagSet - The flag set name we want to get the treatments.
16861698
* @param attributes - An object of type Attributes defining the attributes for the given key.
1699+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16871700
* @returns TreatmentsWithConfig promise that resolves to the map of TreatmentsWithConfig objects.
16881701
*/
16891702
getTreatmentsWithConfigByFlagSet(key: SplitKey, flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
@@ -1693,6 +1706,7 @@ declare namespace SplitIO {
16931706
* @param key - The string key representing the consumer.
16941707
* @param flagSets - An array of the flag set names we want to get the treatments.
16951708
* @param attributes - An object of type Attributes defining the attributes for the given key.
1709+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
16961710
* @returns Treatments promise that resolves to the treatments object map.
16971711
*/
16981712
getTreatmentsByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
@@ -1702,6 +1716,7 @@ declare namespace SplitIO {
17021716
* @param key - The string key representing the consumer.
17031717
* @param flagSets - An array of the flag set names we want to get the treatments.
17041718
* @param attributes - An object of type Attributes defining the attributes for the given key.
1719+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
17051720
* @returns TreatmentsWithConfig promise that resolves to the map of TreatmentsWithConfig objects.
17061721
*/
17071722
getTreatmentsWithConfigByFlagSets(key: SplitKey, flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
@@ -1769,6 +1784,7 @@ declare namespace SplitIO {
17691784
*
17701785
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
17711786
* @param attributes - An object of type Attributes defining the attributes for the given key.
1787+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
17721788
* @returns The treatment string.
17731789
*/
17741790
getTreatment(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): Treatment;
@@ -1777,14 +1793,16 @@ declare namespace SplitIO {
17771793
*
17781794
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
17791795
* @param attributes - An object of type Attributes defining the attributes for the given key.
1780-
* @returns The map containing the treatment and the configuration stringified JSON (or null if there was no config for that treatment).
1796+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
1797+
* @returns The TreatmentWithConfig object that contains the treatment string and the configuration stringified JSON (or null if there was no config for that treatment).
17811798
*/
17821799
getTreatmentWithConfig(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentWithConfig;
17831800
/**
17841801
* Returns a Treatments value, which is an object map with the treatments for the given features.
17851802
*
17861803
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
17871804
* @param attributes - An object of type Attributes defining the attributes for the given key.
1805+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
17881806
* @returns The treatments object map.
17891807
*/
17901808
getTreatments(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
@@ -1793,6 +1811,7 @@ declare namespace SplitIO {
17931811
*
17941812
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
17951813
* @param attributes - An object of type Attributes defining the attributes for the given key.
1814+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
17961815
* @returns The map with all the TreatmentWithConfig objects
17971816
*/
17981817
getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
@@ -1801,6 +1820,7 @@ declare namespace SplitIO {
18011820
*
18021821
* @param flagSet - The flag set name we want to get the treatments.
18031822
* @param attributes - An object of type Attributes defining the attributes for the given key.
1823+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18041824
* @returns The map with all the Treatments objects
18051825
*/
18061826
getTreatmentsByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): Treatments;
@@ -1809,6 +1829,7 @@ declare namespace SplitIO {
18091829
*
18101830
* @param flagSet - The flag set name we want to get the treatments.
18111831
* @param attributes - An object of type Attributes defining the attributes for the given key.
1832+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18121833
* @returns The map with all the TreatmentWithConfig objects
18131834
*/
18141835
getTreatmentsWithConfigByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
@@ -1817,6 +1838,7 @@ declare namespace SplitIO {
18171838
*
18181839
* @param flagSets - An array of the flag set names we want to get the treatments.
18191840
* @param attributes - An object of type Attributes defining the attributes for the given key.
1841+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18201842
* @returns The map with all the Treatments objects
18211843
*/
18221844
getTreatmentsByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): Treatments;
@@ -1825,6 +1847,7 @@ declare namespace SplitIO {
18251847
*
18261848
* @param flagSets - An array of the flag set names we want to get the treatments.
18271849
* @param attributes - An object of type Attributes defining the attributes for the given key.
1850+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18281851
* @returns The map with all the TreatmentWithConfig objects
18291852
*/
18301853
getTreatmentsWithConfigByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): TreatmentsWithConfig;
@@ -1848,6 +1871,7 @@ declare namespace SplitIO {
18481871
*
18491872
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
18501873
* @param attributes - An object of type Attributes defining the attributes for the given key.
1874+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18511875
* @returns Treatment promise that resolves to the treatment string.
18521876
*/
18531877
getTreatment(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatment;
@@ -1856,6 +1880,7 @@ declare namespace SplitIO {
18561880
*
18571881
* @param featureFlagName - The string that represents the feature flag we want to get the treatment.
18581882
* @param attributes - An object of type Attributes defining the attributes for the given key.
1883+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18591884
* @returns TreatmentWithConfig promise that resolves to the TreatmentWithConfig object.
18601885
*/
18611886
getTreatmentWithConfig(featureFlagName: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentWithConfig;
@@ -1864,6 +1889,7 @@ declare namespace SplitIO {
18641889
*
18651890
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
18661891
* @param attributes - An object of type Attributes defining the attributes for the given key.
1892+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18671893
* @returns Treatments promise that resolves to the treatments object map.
18681894
*/
18691895
getTreatments(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
@@ -1872,6 +1898,7 @@ declare namespace SplitIO {
18721898
*
18731899
* @param featureFlagNames - An array of the feature flag names we want to get the treatments.
18741900
* @param attributes - An object of type Attributes defining the attributes for the given key.
1901+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18751902
* @returns TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
18761903
*/
18771904
getTreatmentsWithConfig(featureFlagNames: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
@@ -1880,6 +1907,7 @@ declare namespace SplitIO {
18801907
*
18811908
* @param flagSet - The flag set name we want to get the treatments.
18821909
* @param attributes - An object of type Attributes defining the attributes for the given key.
1910+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18831911
* @returns Treatments promise that resolves to the treatments object map.
18841912
*/
18851913
getTreatmentsByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
@@ -1888,6 +1916,7 @@ declare namespace SplitIO {
18881916
*
18891917
* @param flagSet - The flag set name we want to get the treatments.
18901918
* @param attributes - An object of type Attributes defining the attributes for the given key.
1919+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18911920
* @returns TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
18921921
*/
18931922
getTreatmentsWithConfigByFlagSet(flagSet: string, attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;
@@ -1896,6 +1925,7 @@ declare namespace SplitIO {
18961925
*
18971926
* @param flagSets - An array of the flag set names we want to get the treatments.
18981927
* @param attributes - An object of type Attributes defining the attributes for the given key.
1928+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
18991929
* @returns Treatments promise that resolves to the treatments object map.
19001930
*/
19011931
getTreatmentsByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatments;
@@ -1904,6 +1934,7 @@ declare namespace SplitIO {
19041934
*
19051935
* @param flagSets - An array of the flag set names we want to get the treatments.
19061936
* @param attributes - An object of type Attributes defining the attributes for the given key.
1937+
* @param options - An object of type EvaluationOptions for advanced evaluation options.
19071938
* @returns TreatmentsWithConfig promise that resolves to the TreatmentsWithConfig object.
19081939
*/
19091940
getTreatmentsWithConfigByFlagSets(flagSets: string[], attributes?: Attributes, options?: EvaluationOptions): AsyncTreatmentsWithConfig;

0 commit comments

Comments
 (0)