Protected_apiProtected_clientProtected_contextProtected_defaultProtected_domainProtected_domainProtected_hooksProtected_loggerProtected_runsProtected_statusProvider Metadata
Protected_createAdds a handler for the given provider event type. The handlers are called in the order they have been added. API (global) events run for all providers.
The provider event type to listen to
The handler to run on occurrence of the event type
Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.
Rest...hooks: Hook[]A list of hooks that should always run
The receiver (this object)
ProtectedbuildOptionaldomain: stringProtectedclearProtectedgetA factory function for creating new domainless OpenFeature clients. Clients can contain their own state (e.g. logger, hook, context). Multiple clients can be used to segment feature flag configuration.
All domainless or unbound clients use the default provider set via this.setProvider setProvider.
Optionalcontext: EvaluationContextEvaluation context that should be set on the client to used during flag evaluations
OpenFeature Client
A factory function for creating new domain scoped OpenFeature clients. Clients can contain their own state (e.g. logger, hook, context). Multiple clients can be used to segment feature flag configuration.
If there is already a provider bound to this domain via this.setProvider setProvider, this provider will be used. Otherwise, the default provider is used until a provider is assigned to that domain.
An identifier which logically binds clients with providers
Optionalcontext: EvaluationContextEvaluation context that should be set on the client to used during flag evaluations
OpenFeature Client
A factory function for creating new domain scoped OpenFeature clients. Clients can contain their own state (e.g. logger, hook, context). Multiple clients can be used to segment feature flag configuration.
If there is already a provider bound to this domain via this.setProvider setProvider, this provider will be used. Otherwise, the default provider is used until a provider is assigned to that domain.
An identifier which logically binds clients with providers
The version of the client (only used for metadata)
Optionalcontext: EvaluationContextEvaluation context that should be set on the client to used during flag evaluations
OpenFeature Client
Access the evaluation context set on the receiver.
Evaluation context
Gets the current handlers for the given provider event type.
The provider event type to get the current handlers for
The handlers currently attached to the given provider event type
ProtectedgetGet metadata about a registered provider using the client name. An unbound or empty client name will return metadata from the default provider.
Optionaldomain: stringAn identifier which logically binds clients with providers
Provider Metadata
Returns the currently defined transaction context using the registered transaction context propagator.
The current transaction context
Removes a handler for the given provider event type.
The provider event type to remove the listener for
The handler to remove for the provider event type
ProtectedsetSets evaluation context that will be used during flag evaluations on this receiver.
Evaluation context
The receiver (this object)
Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.
The logger to be used
The receiver (this object)
Sets the default provider for flag evaluations. This provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.
The provider responsible for flag evaluations.
OpenFeature API
Sets the provider for flag evaluations of providers with the given name. Setting a provider supersedes the current provider used in new and existing clients bound to the same domain.
The name to identify the client
The provider responsible for flag evaluations.
OpenFeature API
Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. This provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.
The provider responsible for flag evaluations.
Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients bound to the same domain.
The name to identify the client
The provider responsible for flag evaluations.
Sets the transaction context using the registered transaction context propagator. Runs the callback function, in which the transactionContext will be available by calling this#getTransactionContext.
The TransactionContextPropagator must persist the transactionContext and make it available to callback via this#getTransactionContext.
The precedence of merging context can be seen in the specification.
Example:
app.use((req: Request, res: Response, next: NextFunction) => {
const ip = res.headers.get("X-Forwarded-For")
OpenFeature.setTransactionContext({ targetingKey: req.user.id, ipAddress: ip }, () => {
// The transaction context is used in any flag evaluation throughout the whole call chain of next
next();
});
})
Sets a transaction context propagator on this receiver. The transaction context propagator is responsible for persisting context for the duration of a single transaction.
The context propagator to be used
The receiver (this object)
Get metadata about the default provider.