You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification.json
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@
59
59
{
60
60
"id": "Requirement 1.1.6",
61
61
"machine_id": "requirement_1_1_6",
62
-
"content": "The `API` MUST provide a function for creating a `client` which accepts the following options: - domain (optional): A logical string identifier for binding clients to provider.",
62
+
"content": "The `API` MUST provide a function for creating a `client` which accepts the following options: - domain (optional): A logical string identifier for binding a client to a provider.",
63
63
"RFC 2119 keyword": "MUST",
64
64
"children": []
65
65
},
@@ -539,7 +539,7 @@
539
539
{
540
540
"id": "Requirement 3.1.4",
541
541
"machine_id": "requirement_3_1_4",
542
-
"content": "The evaluation context fields MUST have an unique key.",
542
+
"content": "The evaluation context fields MUST have a unique key.",
543
543
"RFC 2119 keyword": "MUST",
544
544
"children": []
545
545
},
@@ -991,7 +991,7 @@
991
991
{
992
992
"id": "Requirement 5.2.4",
993
993
"machine_id": "requirement_5_2_4",
994
-
"content": "The `handler function` MUST accept a `event details` parameter.",
994
+
"content": "The `handler function` MUST accept an `event details` parameter.",
Copy file name to clipboardExpand all lines: specification/glossary.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -123,7 +123,7 @@ The possible states and transitions of a provider over the course of its usage,
123
123
124
124
### Domain
125
125
126
-
An identifier which logically binds clients with providers, allowing for multiple providers to be used simultaneously within a single application. Domain binding is dynamic; it may change over the course of an application's lifetime (ie: a client associated to the default provider via an unbound domain will be bound to a new provider if a provider is subsequently assigned to that domain).
126
+
An identifier which logically binds clients with providers, allowing for multiple providers to be used simultaneously within a single application. Domain binding is dynamic; it may change over the course of an application's lifetime (i.e.: a client associated with the default provider via an unbound domain will be bound to a new provider if a provider is subsequently assigned to that domain).
127
127
128
128
### Integration
129
129
@@ -139,15 +139,15 @@ An SDK-compliant implementation that stores and returns transaction-specific eva
139
139
140
140
### Evaluating Flag Values
141
141
142
-
The process of retrieving a feature flag value in it's entirety, including:
142
+
The process of retrieving a feature flag value in its entirety, including:
143
143
144
144
- any effects resulting from hooks
145
145
- resolving a flag value from a configured provider
146
146
- falling back to a supplied default, in the case of abnormal execution
147
147
148
148
### Resolving Flag Values
149
149
150
-
The process of a provider retrieving a feature flag value from it's particular source-of-truth.
150
+
The process of a provider retrieving a feature flag value from its particular source-of-truth.
Copy file name to clipboardExpand all lines: specification/sections/01-flag-evaluation.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ See [provider](./02-providers.md), [creating clients](#creating-clients) for det
42
42
43
43
Application authors can await the newly set `provider's` readiness using the `PROVIDER_READY` event.
44
44
Provider instances which are already active (because they have been bound to another `domain` or otherwise) need not be initialized again.
45
-
The `provider's` readiness can state can be determined from its `status` member/accessor.
45
+
The `provider's` readiness state can be determined from its `status` member/accessor.
46
46
47
47
See [event handlers and initialization](./05-events.md#event-handlers-and-initialization), [provider initialization](./02-providers.md#24-initialization), [domain](../glossary.md#domain) for details.
> The evaluation context fields **MUST** have an unique key.
42
+
> The evaluation context fields **MUST** have a unique key.
43
43
44
44
The key uniquely identifies a field in the `evaluation context` and it should be unique across all types to avoid any collision when marshalling the `evaluation context` by the provider.
> When the global `evaluation context` is set, the `on context changed` function **MUST** run.
128
128
129
-
The SDK implementation must run the `on context changed` function on all registered provider that use the global `evaluation context` whenever it is mutated.
129
+
The SDK implementation must run the `on context changed` function on all registered providers that use the global `evaluation context` whenever it is mutated.
Copy file name to clipboardExpand all lines: specification/sections/05-events.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ graph
23
23
```
24
24
25
25
The `domain` of a provider constitutes a logical scope for events.
26
-
Clients associated to a particular provider through a `domain`, run event handlers only when that provider emits events, or one of its lifecycle functions terminates.
26
+
Clients associated with a particular provider through a `domain` run event handlers only when that provider emits events, or one of its lifecycle functions terminates.
> The `provider`**MAY** define a mechanism for signaling the occurrence of one of a set of events, including `PROVIDER_READY`, `PROVIDER_ERROR`, `PROVIDER_CONFIGURATION_CHANGED` and `PROVIDER_STALE`, with a `provider event details` payload.
35
35
36
-
Providers cannot emit `PROVIDER_CONTEXT_CHANGED` or `PROVIDER_RECONCILING`event.
36
+
Providers cannot emit `PROVIDER_CONTEXT_CHANGED` or `PROVIDER_RECONCILING`events.
37
37
These are emitted only by the SDK during context reconciliation.
38
38
39
39
If available, native event-emitter or observable/observer language constructs can be used.
@@ -112,7 +112,7 @@ See [setting a provider](./01-flag-evaluation.md#setting-a-provider), [creating
112
112
113
113
#### Requirement 5.2.4
114
114
115
-
> The `handler function`**MUST** accept a`event details` parameter.
115
+
> The `handler function`**MUST** accept an`event details` parameter.
116
116
117
117
see: [`event details`](../types.md#event-details)
118
118
@@ -164,7 +164,7 @@ See [provider initialization](./02-providers.md#24-initialization) and [setting
164
164
165
165
Handlers may be attached at any point in the application lifecycle.
166
166
Handlers should run immediately if the provider is already in the associated state.
167
-
For instance, _application authors_ may attach readiness handlers to be confident that system is ready to evaluate flags.
167
+
For instance, _application authors_ may attach readiness handlers to be confident that the system is ready to evaluate flags.
168
168
If such handlers are attached after the provider underlying the client has already been initialized, they should run immediately.
169
169
170
170
See [provider initialization](./02-providers.md#24-initialization), [setting a provider](./01-flag-evaluation.md#setting-a-provider).
0 commit comments