-
Notifications
You must be signed in to change notification settings - Fork 29
/
evaluation.ts
177 lines (162 loc) · 6.84 KB
/
evaluation.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
import { EvaluationContext, EvaluationDetails, HookHints, JsonValue } from '@openfeature/core';
import { Hook } from '../hooks';
export interface FlagEvaluationOptions {
hooks?: Hook[];
hookHints?: HookHints;
}
export interface Features {
/**
* Performs a flag evaluation that returns a boolean.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @param {boolean} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<boolean>} Flag evaluation response
*/
getBooleanValue(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<boolean>;
/**
* Performs a flag evaluation that a returns an evaluation details object.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @param {boolean} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<EvaluationDetails<boolean>>} Flag evaluation details response
*/
getBooleanDetails(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<EvaluationDetails<boolean>>;
/**
* Performs a flag evaluation that returns a string.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @template {string} T A optional generic argument constraining the string
* @param {T} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<T>} Flag evaluation response
*/
getStringValue(
flagKey: string,
defaultValue: string,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<string>;
getStringValue<T extends string = string>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<T>;
/**
* Performs a flag evaluation that a returns an evaluation details object.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @template {string} T A optional generic argument constraining the string
* @param {T} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<EvaluationDetails<T>>} Flag evaluation details response
*/
getStringDetails(
flagKey: string,
defaultValue: string,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<EvaluationDetails<string>>;
getStringDetails<T extends string = string>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<EvaluationDetails<T>>;
/**
* Performs a flag evaluation that returns a number.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @template {number} T A optional generic argument constraining the number
* @param {T} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<T>} Flag evaluation response
*/
getNumberValue(
flagKey: string,
defaultValue: number,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<number>;
getNumberValue<T extends number = number>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<T>;
/**
* Performs a flag evaluation that a returns an evaluation details object.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @template {number} T A optional generic argument constraining the number
* @param {T} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<EvaluationDetails<T>>} Flag evaluation details response
*/
getNumberDetails(
flagKey: string,
defaultValue: number,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<EvaluationDetails<number>>;
getNumberDetails<T extends number = number>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<EvaluationDetails<T>>;
/**
* Performs a flag evaluation that returns an object.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @template {JsonValue} T A optional generic argument describing the structure
* @param {T} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<T>} Flag evaluation response
*/
getObjectValue(
flagKey: string,
defaultValue: JsonValue,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<JsonValue>;
getObjectValue<T extends JsonValue = JsonValue>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<T>;
/**
* Performs a flag evaluation that a returns an evaluation details object.
* @param {string} flagKey The flag key uniquely identifies a particular flag
* @template {JsonValue} T A optional generic argument describing the structure
* @param {T} defaultValue The value returned if an error occurs
* @param {EvaluationContext} context The evaluation context used on an individual flag evaluation
* @param {FlagEvaluationOptions} options Additional flag evaluation options
* @returns {Promise<EvaluationDetails<T>>} Flag evaluation details response
*/
getObjectDetails(
flagKey: string,
defaultValue: JsonValue,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<EvaluationDetails<JsonValue>>;
getObjectDetails<T extends JsonValue = JsonValue>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
options?: FlagEvaluationOptions,
): Promise<EvaluationDetails<T>>;
}