Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsAbstractThe GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included in the event details.
-Optionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventOptionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventSets 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)
-Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsAbstractAbstractProtected Abstract Readonly_apiProtected_clientProtected_contextProtected Abstract_defaultProtected_domainProtected Abstract Readonly_domainProtected_hooksProtected_loggerProtected_runsProtected Abstract Readonly_statusGet metadata about the default provider.
+Protected Abstract Readonly_apiProtected_clientProtected_contextProtected Abstract_defaultProtected_domainProtected Abstract Readonly_domainProtected_hooksProtected_loggerProtected_runsProtected Abstract Readonly_statusGet metadata about the default provider.
Provider Metadata
-Protected Abstract_createAdds a handler for the given provider event type. +
Protected Abstract_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: H[]A list of hooks that should always run
The receiver (this object)
-ProtectedbuildOptionaldomain: stringClears all the hooks that are registered on this receiver.
+ProtectedbuildOptionaldomain: stringProtectedclearProtectedgetGets the current handlers for the given provider event type.
+ProtectedclearProtectedgetGets 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
-Access all the hooks that are registered on this receiver.
+ProtectedgetGet metadata about a registered provider using the client name. +
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
-Removes a handler for the given provider event type.
+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
-ProtectedsetProtectedsetSets 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)
-AbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractAbstractOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalcauseAbstractcodeOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsA provider and its current status. For internal use only.
-Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsReturns the currently defined transaction context using the registered transaction context propagator.
The current transaction context
-Sets the transaction context using the registered transaction context propagator. +
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 @@ -19,4 +19,4 @@
Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsAbstractThe GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included in the event details.
-Optionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventOptionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventSets 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)
-A simple OpenFeature provider intended for demos and as a test stub.
-ReadonlymetadataReadonlyrunsRepresents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.
-Resolve a boolean flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a numeric flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve and parse an object flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a string flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a boolean flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a numeric flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerResolve and parse an object flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a string flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsProtected_apiProtected_clientProtected_contextProtected_defaultProtected_domainProtected_domainProtected_hooksProtected_loggerProtected_runsProtected_statusGet metadata about the default provider.
+Protected_apiProtected_clientProtected_contextProtected_defaultProtected_domainProtected_domainProtected_hooksProtected_loggerProtected_runsProtected_statusGet metadata about the default provider.
Provider Metadata
-Protected_createAdds a handler for the given provider event type. +
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: stringClears all the hooks that are registered on this receiver.
+ProtectedbuildOptionaldomain: stringProtectedclearProtectedgetA factory function for creating new domainless OpenFeature clients. +
ProtectedclearProtectedgetA 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. +
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. @@ -66,7 +66,7 @@
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. +
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. @@ -75,55 +75,55 @@
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.
+Access the evaluation context set on the receiver.
Evaluation context
-Gets the current handlers for the given provider event type.
+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
-Access all the hooks that are registered on this receiver.
+ProtectedgetGet metadata about a registered provider using the client name. +
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 +
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.
+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
-ProtectedsetProtectedsetSets 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 +
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. +
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. +
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. +
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. +
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 @@ -138,9 +138,9 @@
Sets a transaction context propagator on this receiver. The transaction context +
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)
-AbstractAbstractProtected Abstract Readonly_apiProtected_clientProtected_contextProtected Abstract_defaultProtected_domainProtected Abstract Readonly_domainProtected_hooksProtected_loggerProtected_runsProtected Abstract Readonly_statusGet metadata about the default provider.
+Protected Abstract Readonly_apiProtected_clientProtected_contextProtected Abstract_defaultProtected_domainProtected Abstract Readonly_domainProtected_hooksProtected_loggerProtected_runsProtected Abstract Readonly_statusGet metadata about the default provider.
Provider Metadata
-Protected Abstract_createAdds a handler for the given provider event type. +
Protected Abstract_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: H[]A list of hooks that should always run
The receiver (this object)
-ProtectedbuildOptionaldomain: stringClears all the hooks that are registered on this receiver.
+ProtectedbuildOptionaldomain: stringProtectedclearProtectedgetGets the current handlers for the given provider event type.
+ProtectedclearProtectedgetGets 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
-Access all the hooks that are registered on this receiver.
+ProtectedgetGet metadata about a registered provider using the client name. +
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
-Removes a handler for the given provider event type.
+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
-ProtectedsetProtectedsetSets 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)
-AbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractAbstractOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalcauseAbstractcodeOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackNOTE: Ready and error events are automatically emitted by the SDK based on the result of the initialize method.
-Optionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventOptionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventSets 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)
-Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsA provider and its current status. For internal use only.
-Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsAbstractThe GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included in the event details.
-Optionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventOptionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventSets 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)
-A simple OpenFeature provider intended for demos and as a test stub.
-ReadonlymetadataReadonlyrunsRepresents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.
-Resolve a boolean flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a numeric flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve and parse an object flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a string flag and its evaluation details.
-Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a boolean flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a numeric flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerResolve and parse an object flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerResolve a string flag and its evaluation details.
+Optionalcontext: EvaluationContextOptionallogger: LoggerOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsProtected_apiProtected_clientProtected_contextProtected_defaultProtected_domainProtected_domainProtected_hooksProtected_loggerProtected_runsProtected_statusGet metadata about the default provider.
+Protected_apiProtected_clientProtected_contextProtected_defaultProtected_domainProtected_domainProtected_hooksProtected_loggerProtected_runsProtected_statusGet metadata about the default provider.
Provider Metadata
-Protected_createAdds a handler for the given provider event type. +
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: stringResets the global evaluation context to an empty object.
-Removes the evaluation context for a specific named client.
+ProtectedbuildOptionaldomain: stringResets the global evaluation context to an empty object.
+Removes the evaluation context for a specific named client.
An identifier which logically binds clients with providers
-ProtectedclearProtectedgetA factory function for creating new named OpenFeature clients. Clients can contain +
ProtectedclearProtectedgetA factory function for creating new named 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 name via this.setProvider setProvider, this provider will be used. @@ -64,87 +64,87 @@
Optionaldomain: stringAn identifier which logically binds clients with providers
Optionalversion: stringThe version of the client (only used for metadata)
OpenFeature Client
-Access the global evaluation context.
+Access the global evaluation context.
Evaluation context
-Access the evaluation context for a specific named client. +
Access the evaluation context for a specific named client. The global evaluation context is returned if a matching named client is not found.
Optionaldomain: stringAn identifier which logically binds clients with providers
Evaluation context
-Gets the current handlers for the given provider event type.
+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
-Access all the hooks that are registered on this receiver.
+ProtectedgetGet metadata about a registered provider using the client name. +
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
-Removes a handler for the given provider event type.
+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
-ProtectedsetProtectedsetSets the evaluation context globally. This will be used by all providers that have not bound to a domain.
Evaluation context
Sets the evaluation context for a specific provider. +
Sets the evaluation context for a specific provider. This will only affect providers bound to a domain.
An identifier which logically binds clients with providers
Evaluation context
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. +
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 default provider and evaluation context for flag evaluations. +
Sets the default provider and evaluation context 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.
{EvaluationContext} The evaluation context to use for flag evaluations.
OpenFeature API
-Sets the provider for flag evaluations of providers with the given name. +
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 provider and evaluation context flag evaluations of providers with the given name. +
Sets the provider and evaluation context 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.
{EvaluationContext} The evaluation context to use for flag evaluations.
OpenFeature API
-Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. +
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 default provider for flag evaluations and returns a promise that resolves when the provider is ready. +
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.
The evaluation context to use for flag evaluations.
Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +
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 provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +
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.
The evaluation context to use for flag evaluations.
AbstractAbstractProtected Abstract Readonly_apiProtected_clientProtected_contextProtected Abstract_defaultProtected_domainProtected Abstract Readonly_domainProtected_hooksProtected_loggerProtected_runsProtected Abstract Readonly_statusGet metadata about the default provider.
+Protected Abstract Readonly_apiProtected_clientProtected_contextProtected Abstract_defaultProtected_domainProtected Abstract Readonly_domainProtected_hooksProtected_loggerProtected_runsProtected Abstract Readonly_statusGet metadata about the default provider.
Provider Metadata
-Protected Abstract_createAdds a handler for the given provider event type. +
Protected Abstract_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: H[]A list of hooks that should always run
The receiver (this object)
-ProtectedbuildOptionaldomain: stringClears all the hooks that are registered on this receiver.
+ProtectedbuildOptionaldomain: stringProtectedclearProtectedgetGets the current handlers for the given provider event type.
+ProtectedclearProtectedgetGets 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
-Access all the hooks that are registered on this receiver.
+ProtectedgetGet metadata about a registered provider using the client name. +
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
-Removes a handler for the given provider event type.
+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
-ProtectedsetProtectedsetSets 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)
-AbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractsetOptionalclientOrProvider: string | POptionalproviderContextOrUndefined: EvaluationContext | POptionalcontextOrUndefined: EvaluationContextAbstractAbstractOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalcauseAbstractcodeOptionalstackStatic OptionalprepareOptional override for formatting stack traces
StaticstackNOTE: Ready and error events are automatically emitted by the SDK based on the result of the initialize method.
-Optionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventOptionalcontext: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>OptionaleventType: AnyProviderEventSets 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)
-Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsA provider and its current status. For internal use only.
-Optionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsOptionalmessage: stringOptionaloptions: ErrorOptionsAn enumeration of possible events for web-sdk providers.
-The flag configuration in the source-of-truth has changed.
-The context associated with the provider has changed, and the provider has reconciled it's associated state.
-The provider is in an error state.
-The provider is ready to evaluate flags.
-The context associated with the provider has changed, and the provider has not yet reconciled its associated state.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The context associated with the provider has changed, and the provider has reconciled it's associated state.
+The provider is in an error state.
+The provider is ready to evaluate flags.
+The context associated with the provider has changed, and the provider has not yet reconciled its associated state.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The state of the provider. Note that the provider's state is handled by the SDK.
-The provider is in an error state and unable to evaluate flags.
-The provider has entered an irrecoverable error state.
-The provider has not been initialized and cannot yet evaluate flags.
-The provider is ready to resolve flags.
-The provider is reconciling its state with a context change.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider has entered an irrecoverable error state.
+The provider has not been initialized and cannot yet evaluate flags.
+The provider is ready to resolve flags.
+The provider is reconciling its state with a context change.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The flag could not be found.
-An error with an unspecified code.
-The evaluation context does not meet provider requirements.
-An error was encountered parsing data, such as a flag configuration.
-The provider has entered an irrecoverable error state.
-The value was resolved before the provider was ready.
-The provider requires a targeting key and one was not provided in the evaluation context.
-The type of the flag value does not match the expected type.
-An error with an unspecified code.
+The evaluation context does not meet provider requirements.
+An error was encountered parsing data, such as a flag configuration.
+The provider has entered an irrecoverable error state.
+The value was resolved before the provider was ready.
+The provider requires a targeting key and one was not provided in the evaluation context.
+The type of the flag value does not match the expected type.
+An enumeration of possible events for server-sdk providers.
-The flag configuration in the source-of-truth has changed.
-The provider is in an error state.
-The provider is ready to evaluate flags.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider is in an error state.
+The provider is ready to evaluate flags.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The state of the provider. Note that the provider's state is handled by the SDK.
-The provider is in an error state and unable to evaluate flags.
-The provider has entered an irrecoverable error state.
-The provider has not been initialized and cannot yet evaluate flags.
-The provider is ready to resolve flags.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider has entered an irrecoverable error state.
+The provider has not been initialized and cannot yet evaluate flags.
+The provider is ready to resolve flags.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+An enumeration of possible events for web-sdk providers.
-The flag configuration in the source-of-truth has changed.
-The context associated with the provider has changed, and the provider has reconciled it's associated state.
-The provider is in an error state.
-The provider is ready to evaluate flags.
-The context associated with the provider has changed, and the provider has not yet reconciled its associated state.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The context associated with the provider has changed, and the provider has reconciled it's associated state.
+The provider is in an error state.
+The provider is ready to evaluate flags.
+The context associated with the provider has changed, and the provider has not yet reconciled its associated state.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The state of the provider. Note that the provider's state is handled by the SDK.
-The provider is in an error state and unable to evaluate flags.
-The provider has entered an irrecoverable error state.
-The provider has not been initialized and cannot yet evaluate flags.
-The provider is ready to resolve flags.
-The provider is reconciling its state with a context change.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider has entered an irrecoverable error state.
+The provider has not been initialized and cannot yet evaluate flags.
+The provider is ready to resolve flags.
+The provider is reconciling its state with a context change.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The flag could not be found.
-An error with an unspecified code.
-The evaluation context does not meet provider requirements.
-An error was encountered parsing data, such as a flag configuration.
-The provider has entered an irrecoverable error state.
-The value was resolved before the provider was ready.
-The provider requires a targeting key and one was not provided in the evaluation context.
-The type of the flag value does not match the expected type.
-An error with an unspecified code.
+The evaluation context does not meet provider requirements.
+An error was encountered parsing data, such as a flag configuration.
+The provider has entered an irrecoverable error state.
+The value was resolved before the provider was ready.
+The provider requires a targeting key and one was not provided in the evaluation context.
+The type of the flag value does not match the expected type.
+An enumeration of possible events for server-sdk providers.
-The flag configuration in the source-of-truth has changed.
-The provider is in an error state.
-The provider is ready to evaluate flags.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider is in an error state.
+The provider is ready to evaluate flags.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The state of the provider. Note that the provider's state is handled by the SDK.
-The provider is in an error state and unable to evaluate flags.
-The provider has entered an irrecoverable error state.
-The provider has not been initialized and cannot yet evaluate flags.
-The provider is ready to resolve flags.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider has entered an irrecoverable error state.
+The provider has not been initialized and cannot yet evaluate flags.
+The provider is ready to resolve flags.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The flag could not be found.
-An error with an unspecified code.
-The evaluation context does not meet provider requirements.
-An error was encountered parsing data, such as a flag configuration.
-The provider has entered an irrecoverable error state.
-The value was resolved before the provider was ready.
-The provider requires a targeting key and one was not provided in the evaluation context.
-The type of the flag value does not match the expected type.
-An error with an unspecified code.
+The evaluation context does not meet provider requirements.
+An error was encountered parsing data, such as a flag configuration.
+The provider has entered an irrecoverable error state.
+The value was resolved before the provider was ready.
+The provider requires a targeting key and one was not provided in the evaluation context.
+The type of the flag value does not match the expected type.
+An enumeration of possible events for web-sdk providers.
-The flag configuration in the source-of-truth has changed.
-The context associated with the provider has changed, and the provider has reconciled it's associated state.
-The provider is in an error state.
-The provider is ready to evaluate flags.
-The context associated with the provider has changed, and the provider has not yet reconciled its associated state.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The context associated with the provider has changed, and the provider has reconciled it's associated state.
+The provider is in an error state.
+The provider is ready to evaluate flags.
+The context associated with the provider has changed, and the provider has not yet reconciled its associated state.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The state of the provider. Note that the provider's state is handled by the SDK.
-The provider is in an error state and unable to evaluate flags.
-The provider has entered an irrecoverable error state.
-The provider has not been initialized and cannot yet evaluate flags.
-The provider is ready to resolve flags.
-The provider is reconciling its state with a context change.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider has entered an irrecoverable error state.
+The provider has not been initialized and cannot yet evaluate flags.
+The provider is ready to resolve flags.
+The provider is reconciling its state with a context change.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+An enumeration of possible events for server-sdk providers.
-The flag configuration in the source-of-truth has changed.
-The provider is in an error state.
-The provider is ready to evaluate flags.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider is in an error state.
+The provider is ready to evaluate flags.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+The state of the provider. Note that the provider's state is handled by the SDK.
-The provider is in an error state and unable to evaluate flags.
-The provider has entered an irrecoverable error state.
-The provider has not been initialized and cannot yet evaluate flags.
-The provider is ready to resolve flags.
-The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
-The provider has entered an irrecoverable error state.
+The provider has not been initialized and cannot yet evaluate flags.
+The provider is ready to resolve flags.
+The provider's cached state is no longer valid and may not be up-to-date with the source of truth.
+Optionalmessage: stringOptionalmessage: stringevent to match
Optionalstatus: ClientProviderStatus | ServerProviderStatusstatus of provider
boolean indicating if the provider status corresponds to the event.
-
Optional override for formatting stack traces
+