Skip to content

Commit 3fcb856

Browse files
removed evaluation options from provider method signatures (#134)
BREAKING CHANGE Resolves: #133 Signed-off-by: James-Milligan <[email protected]>
1 parent 186741e commit 3fcb856

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

specification.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187
{
188188
"id": "Requirement 2.2",
189189
"machine_id": "requirement_2_2",
190-
"content": "The `feature provider` interface MUST define methods to resolve flag values, with parameters `flag key` (string, required), `default value` (boolean | number | string | structure, required), `evaluation context` (optional), and `evaluation options` (optional), which returns a `flag resolution` structure.",
190+
"content": "The `feature provider` interface MUST define methods to resolve flag values, with parameters `flag key` (string, required), `default value` (boolean | number | string | structure, required) and `evaluation context` (optional), which returns a `flag resolution` structure.",
191191
"RFC 2119 keyword": "MUST",
192192
"children": []
193193
},

specification/sections/02-providers.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@ provider.getMetadata().getName(); // "my-custom-provider"
3030

3131
##### Requirement 2.2
3232

33-
> The `feature provider` interface **MUST** define methods to resolve flag values, with parameters `flag key` (string, required), `default value` (boolean | number | string | structure, required), `evaluation context` (optional), and `evaluation options` (optional), which returns a `flag resolution` structure.
33+
> The `feature provider` interface **MUST** define methods to resolve flag values, with parameters `flag key` (string, required), `default value` (boolean | number | string | structure, required) and `evaluation context` (optional), which returns a `flag resolution` structure.
3434
3535
```typescript
3636
// example flag resolution function
37-
resolveBooleanValue(flagKey, defaultValue, context, options);
37+
resolveBooleanValue(flagKey, defaultValue, context);
3838
```
3939

4040
see: [flag resolution structure](../types.md#flag-resolution), [flag value resolution](../glossary.md#flag-value-resolution)
@@ -49,16 +49,16 @@ see: [flag resolution structure](../types.md#flag-resolution), [flag value resol
4949
5050
```typescript
5151
// example boolean flag value resolution
52-
ResolutionDetails resolveBooleanValue(string flagKey, boolean defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
52+
ResolutionDetails resolveBooleanValue(string flagKey, boolean defaultValue, context: EvaluationContext);
5353

5454
// example string flag value resolution
55-
ResolutionDetails resolveStringValue(string flagKey, string defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
55+
ResolutionDetails resolveStringValue(string flagKey, string defaultValue, context: EvaluationContext);
5656

5757
// example number flag value resolution
58-
ResolutionDetails resolveNumberValue(string flagKey, number defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
58+
ResolutionDetails resolveNumberValue(string flagKey, number defaultValue, context: EvaluationContext);
5959

6060
// example structure flag value resolution
61-
ResolutionDetails resolveStructureValue(string flagKey, JsonObject defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
61+
ResolutionDetails resolveStructureValue(string flagKey, JsonObject defaultValue, context: EvaluationContext);
6262
```
6363

6464
##### Requirement 2.4
@@ -99,16 +99,16 @@ The provider might throw an exception, return an error, or populate the `error c
9999
100100
```typescript
101101
// example boolean flag value resolution with generic argument
102-
ResolutionDetails<boolean> resolveBooleanValue(string flagKey, boolean defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
102+
ResolutionDetails<boolean> resolveBooleanValue(string flagKey, boolean defaultValue, context: EvaluationContext);
103103

104104
// example string flag value resolution with generic argument
105-
ResolutionDetails<string> resolveStringValue(string flagKey, string defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
105+
ResolutionDetails<string> resolveStringValue(string flagKey, string defaultValue, context: EvaluationContext);
106106

107107
// example number flag value resolution with generic argument
108-
ResolutionDetails<number> resolveNumberValue(string flagKey, number defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
108+
ResolutionDetails<number> resolveNumberValue(string flagKey, number defaultValue, context: EvaluationContext);
109109

110110
// example structure flag value resolution with generic argument
111-
ResolutionDetails<MyStruct> resolveStructureValue(string flagKey, MyStruct defaultValue, context: EvaluationContext, options: FlagEvaluationOptions);
111+
ResolutionDetails<MyStruct> resolveStructureValue(string flagKey, MyStruct defaultValue, context: EvaluationContext);
112112
```
113113

114114
#### Provider hooks

0 commit comments

Comments
 (0)