From aa7880d66b3ecbba2110277c41d8011879478ead Mon Sep 17 00:00:00 2001 From: toddbaert Date: Thu, 22 Feb 2024 18:15:01 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=20e3a73?= =?UTF-8?q?7834720ab88c4bb7ca2e3b6a3a3fd7d25c5=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- classes/_openfeature_core.DefaultLogger.html | 4 +- .../_openfeature_core.FlagNotFoundError.html | 4 +- classes/_openfeature_core.GeneralError.html | 4 +- ..._openfeature_core.GenericEventEmitter.html | 6 +-- ..._openfeature_core.InvalidContextError.html | 4 +- ...openfeature_core.OpenFeatureCommonAPI.html | 32 ++++++------ .../_openfeature_core.OpenFeatureError.html | 4 +- classes/_openfeature_core.ParseError.html | 4 +- ...penfeature_core.ProviderNotReadyError.html | 4 +- classes/_openfeature_core.SafeLogger.html | 4 +- ...feature_core.TargetingKeyMissingError.html | 4 +- .../_openfeature_core.TypeMismatchError.html | 4 +- ..._openfeature_server_sdk.DefaultLogger.html | 4 +- ...nfeature_server_sdk.FlagNotFoundError.html | 4 +- .../_openfeature_server_sdk.GeneralError.html | 4 +- ...eature_server_sdk.GenericEventEmitter.html | 6 +-- ...enfeature_server_sdk.InMemoryProvider.html | 18 +++---- ...eature_server_sdk.InvalidContextError.html | 4 +- ...openfeature_server_sdk.OpenFeatureAPI.html | 50 +++++++++---------- ...nfeature_server_sdk.OpenFeatureClient.html | 38 +++++++------- ...ature_server_sdk.OpenFeatureCommonAPI.html | 32 ++++++------ ...enfeature_server_sdk.OpenFeatureError.html | 4 +- ...re_server_sdk.OpenFeatureEventEmitter.html | 6 +-- .../_openfeature_server_sdk.ParseError.html | 4 +- ...ture_server_sdk.ProviderNotReadyError.html | 4 +- .../_openfeature_server_sdk.SafeLogger.html | 4 +- ...e_server_sdk.TargetingKeyMissingError.html | 4 +- ...nfeature_server_sdk.TypeMismatchError.html | 4 +- .../_openfeature_web_sdk.DefaultLogger.html | 4 +- ...openfeature_web_sdk.FlagNotFoundError.html | 4 +- .../_openfeature_web_sdk.GeneralError.html | 4 +- ...enfeature_web_sdk.GenericEventEmitter.html | 6 +-- ..._openfeature_web_sdk.InMemoryProvider.html | 22 ++++---- ...enfeature_web_sdk.InvalidContextError.html | 4 +- .../_openfeature_web_sdk.OpenFeatureAPI.html | 50 +++++++++---------- ...openfeature_web_sdk.OpenFeatureClient.html | 36 ++++++------- ...nfeature_web_sdk.OpenFeatureCommonAPI.html | 32 ++++++------ ..._openfeature_web_sdk.OpenFeatureError.html | 4 +- ...ature_web_sdk.OpenFeatureEventEmitter.html | 6 +-- classes/_openfeature_web_sdk.ParseError.html | 4 +- ...feature_web_sdk.ProviderNotReadyError.html | 4 +- classes/_openfeature_web_sdk.SafeLogger.html | 4 +- ...ture_web_sdk.TargetingKeyMissingError.html | 4 +- ...openfeature_web_sdk.TypeMismatchError.html | 4 +- ...openfeature_core.ClientProviderEvents.html | 12 ++--- enums/_openfeature_core.ErrorCode.html | 16 +++--- enums/_openfeature_core.ProviderStatus.html | 10 ++-- ...openfeature_core.ServerProviderEvents.html | 10 ++-- ...ature_server_sdk.ClientProviderEvents.html | 12 ++--- enums/_openfeature_server_sdk.ErrorCode.html | 16 +++--- ...openfeature_server_sdk.ProviderEvents.html | 10 ++-- ...openfeature_server_sdk.ProviderStatus.html | 10 ++-- enums/_openfeature_web_sdk.ErrorCode.html | 16 +++--- .../_openfeature_web_sdk.ProviderEvents.html | 12 ++--- .../_openfeature_web_sdk.ProviderStatus.html | 10 ++-- ...nfeature_web_sdk.ServerProviderEvents.html | 10 ++-- functions/_openfeature_core.isObject.html | 2 +- functions/_openfeature_core.isString.html | 2 +- .../_openfeature_core.objectOrUndefined.html | 2 +- .../_openfeature_core.statusMatchesEvent.html | 2 +- .../_openfeature_core.stringOrUndefined.html | 2 +- .../_openfeature_server_sdk.isObject.html | 2 +- .../_openfeature_server_sdk.isString.html | 2 +- ...nfeature_server_sdk.objectOrUndefined.html | 2 +- ...feature_server_sdk.statusMatchesEvent.html | 2 +- ...nfeature_server_sdk.stringOrUndefined.html | 2 +- functions/_openfeature_web_sdk.isObject.html | 2 +- functions/_openfeature_web_sdk.isString.html | 2 +- ...openfeature_web_sdk.objectOrUndefined.html | 2 +- ...penfeature_web_sdk.statusMatchesEvent.html | 2 +- ...openfeature_web_sdk.stringOrUndefined.html | 2 +- interfaces/_openfeature_core.BaseHook.html | 10 ++-- .../_openfeature_core.BeforeHookContext.html | 4 +- .../_openfeature_core.ClientMetadata.html | 6 +-- .../_openfeature_core.CommonProvider.html | 12 ++--- ..._openfeature_core.EvaluationLifeCycle.html | 8 +-- interfaces/_openfeature_core.Eventing.html | 8 +-- interfaces/_openfeature_core.HookContext.html | 4 +- interfaces/_openfeature_core.Logger.html | 4 +- .../_openfeature_core.ManageContext.html | 6 +-- .../_openfeature_core.ManageLogger.html | 4 +- interfaces/_openfeature_core.Metadata.html | 2 +- ...openfeature_core.ProviderEventEmitter.html | 6 +-- .../_openfeature_core.ProviderMetadata.html | 4 +- .../_openfeature_server_sdk.BaseHook.html | 10 ++-- ...nfeature_server_sdk.BeforeHookContext.html | 4 +- .../_openfeature_server_sdk.Client.html | 38 +++++++------- ...openfeature_server_sdk.ClientMetadata.html | 6 +-- ...openfeature_server_sdk.CommonProvider.html | 12 ++--- ...eature_server_sdk.EvaluationLifeCycle.html | 8 +-- .../_openfeature_server_sdk.Eventing.html | 8 +-- .../_openfeature_server_sdk.Features.html | 18 +++---- ...ture_server_sdk.FlagEvaluationOptions.html | 4 +- .../_openfeature_server_sdk.HookContext.html | 4 +- .../_openfeature_server_sdk.Logger.html | 4 +- ..._openfeature_server_sdk.ManageContext.html | 6 +-- .../_openfeature_server_sdk.ManageLogger.html | 4 +- ...dk.ManageTransactionContextPropagator.html | 8 +-- .../_openfeature_server_sdk.Metadata.html | 2 +- .../_openfeature_server_sdk.Provider.html | 22 ++++---- ...ature_server_sdk.ProviderEventEmitter.html | 6 +-- ...enfeature_server_sdk.ProviderMetadata.html | 4 +- ...rver_sdk.TransactionContextPropagator.html | 6 +-- interfaces/_openfeature_web_sdk.BaseHook.html | 10 ++-- ...openfeature_web_sdk.BeforeHookContext.html | 4 +- interfaces/_openfeature_web_sdk.Client.html | 36 ++++++------- .../_openfeature_web_sdk.ClientMetadata.html | 6 +-- .../_openfeature_web_sdk.CommonProvider.html | 12 ++--- ...enfeature_web_sdk.EvaluationLifeCycle.html | 8 +-- interfaces/_openfeature_web_sdk.Eventing.html | 8 +-- interfaces/_openfeature_web_sdk.Features.html | 18 +++---- ...feature_web_sdk.FlagEvaluationOptions.html | 4 +- .../_openfeature_web_sdk.HookContext.html | 4 +- interfaces/_openfeature_web_sdk.Logger.html | 4 +- .../_openfeature_web_sdk.ManageContext.html | 6 +-- .../_openfeature_web_sdk.ManageLogger.html | 4 +- interfaces/_openfeature_web_sdk.Metadata.html | 2 +- interfaces/_openfeature_web_sdk.Provider.html | 24 ++++----- ...nfeature_web_sdk.ProviderEventEmitter.html | 6 +-- ..._openfeature_web_sdk.ProviderMetadata.html | 4 +- modules/_openfeature_server_sdk.html | 6 +-- types/_openfeature_core.AnyProviderEvent.html | 2 +- .../_openfeature_core.CommonEventDetails.html | 2 +- .../_openfeature_core.ConfigChangeEvent.html | 2 +- types/_openfeature_core.ErrorEvent.html | 2 +- .../_openfeature_core.EvaluationContext.html | 2 +- ...enfeature_core.EvaluationContextValue.html | 2 +- .../_openfeature_core.EvaluationDetails.html | 2 +- types/_openfeature_core.EventContext.html | 2 +- types/_openfeature_core.EventDetails.html | 2 +- types/_openfeature_core.EventHandler.html | 2 +- types/_openfeature_core.EventMetadata.html | 2 +- types/_openfeature_core.FlagMetadata.html | 2 +- types/_openfeature_core.FlagValue.html | 2 +- types/_openfeature_core.FlagValueType.html | 2 +- types/_openfeature_core.HookHints.html | 2 +- types/_openfeature_core.JsonArray.html | 2 +- types/_openfeature_core.JsonObject.html | 2 +- types/_openfeature_core.JsonValue.html | 2 +- types/_openfeature_core.Paradigm.html | 2 +- types/_openfeature_core.PrimitiveValue.html | 2 +- types/_openfeature_core.ReadyEvent.html | 2 +- .../_openfeature_core.ResolutionDetails.html | 2 +- types/_openfeature_core.ResolutionReason.html | 2 +- types/_openfeature_core.StaleEvent.html | 2 +- ...enfeature_server_sdk.AnyProviderEvent.html | 2 +- ...feature_server_sdk.CommonEventDetails.html | 2 +- ...nfeature_server_sdk.ConfigChangeEvent.html | 2 +- types/_openfeature_server_sdk.ErrorEvent.html | 2 +- ...nfeature_server_sdk.EvaluationContext.html | 2 +- ...ure_server_sdk.EvaluationContextValue.html | 2 +- ...nfeature_server_sdk.EvaluationDetails.html | 2 +- .../_openfeature_server_sdk.EventContext.html | 2 +- .../_openfeature_server_sdk.EventDetails.html | 2 +- .../_openfeature_server_sdk.EventHandler.html | 2 +- ..._openfeature_server_sdk.EventMetadata.html | 2 +- .../_openfeature_server_sdk.FlagMetadata.html | 2 +- types/_openfeature_server_sdk.FlagValue.html | 2 +- ..._openfeature_server_sdk.FlagValueType.html | 2 +- types/_openfeature_server_sdk.Hook.html | 2 +- types/_openfeature_server_sdk.HookHints.html | 2 +- types/_openfeature_server_sdk.JsonArray.html | 2 +- types/_openfeature_server_sdk.JsonObject.html | 2 +- types/_openfeature_server_sdk.JsonValue.html | 2 +- types/_openfeature_server_sdk.Paradigm.html | 2 +- ...openfeature_server_sdk.PrimitiveValue.html | 2 +- types/_openfeature_server_sdk.ReadyEvent.html | 2 +- ...nfeature_server_sdk.ResolutionDetails.html | 2 +- ...enfeature_server_sdk.ResolutionReason.html | 2 +- types/_openfeature_server_sdk.StaleEvent.html | 2 +- ...feature_server_sdk.TransactionContext.html | 2 +- ..._openfeature_web_sdk.AnyProviderEvent.html | 2 +- ...penfeature_web_sdk.CommonEventDetails.html | 2 +- ...openfeature_web_sdk.ConfigChangeEvent.html | 2 +- types/_openfeature_web_sdk.ErrorEvent.html | 2 +- ...openfeature_web_sdk.EvaluationContext.html | 2 +- ...eature_web_sdk.EvaluationContextValue.html | 2 +- ...openfeature_web_sdk.EvaluationDetails.html | 2 +- types/_openfeature_web_sdk.EventContext.html | 2 +- types/_openfeature_web_sdk.EventDetails.html | 2 +- types/_openfeature_web_sdk.EventHandler.html | 2 +- types/_openfeature_web_sdk.EventMetadata.html | 2 +- types/_openfeature_web_sdk.FlagMetadata.html | 2 +- types/_openfeature_web_sdk.FlagValue.html | 2 +- types/_openfeature_web_sdk.FlagValueType.html | 2 +- types/_openfeature_web_sdk.Hook.html | 2 +- types/_openfeature_web_sdk.HookHints.html | 2 +- types/_openfeature_web_sdk.JsonArray.html | 2 +- types/_openfeature_web_sdk.JsonObject.html | 2 +- types/_openfeature_web_sdk.JsonValue.html | 2 +- types/_openfeature_web_sdk.Paradigm.html | 2 +- .../_openfeature_web_sdk.PrimitiveValue.html | 2 +- ...ature_web_sdk.ProviderEmittableEvents.html | 2 +- types/_openfeature_web_sdk.ReadyEvent.html | 2 +- ...openfeature_web_sdk.ResolutionDetails.html | 2 +- ..._openfeature_web_sdk.ResolutionReason.html | 2 +- types/_openfeature_web_sdk.StaleEvent.html | 2 +- variables/_openfeature_core.LOG_LEVELS.html | 2 +- ...eature_core.StandardResolutionReasons.html | 2 +- .../_openfeature_server_sdk.LOG_LEVELS.html | 2 +- ..._openfeature_server_sdk.NOOP_PROVIDER.html | 2 +- ...k.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html | 2 +- .../_openfeature_server_sdk.OpenFeature.html | 2 +- ..._server_sdk.StandardResolutionReasons.html | 2 +- .../_openfeature_web_sdk.LOG_LEVELS.html | 2 +- .../_openfeature_web_sdk.NOOP_PROVIDER.html | 2 +- .../_openfeature_web_sdk.OpenFeature.html | 2 +- ...ure_web_sdk.StandardResolutionReasons.html | 2 +- 208 files changed, 613 insertions(+), 613 deletions(-) diff --git a/classes/_openfeature_core.DefaultLogger.html b/classes/_openfeature_core.DefaultLogger.html index 79f3781ec..dd77e357e 100644 --- a/classes/_openfeature_core.DefaultLogger.html +++ b/classes/_openfeature_core.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor +DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor

Methods

debug error info warn -

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.FlagNotFoundError.html b/classes/_openfeature_core.FlagNotFoundError.html index 8bd507937..112431db9 100644 --- a/classes/_openfeature_core.FlagNotFoundError.html +++ b/classes/_openfeature_core.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_core.GeneralError.html b/classes/_openfeature_core.GeneralError.html index 74a9e7223..1765485ec 100644 --- a/classes/_openfeature_core.GeneralError.html +++ b/classes/_openfeature_core.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_core.GenericEventEmitter.html b/classes/_openfeature_core.GenericEventEmitter.html index ba926a1e3..62b6ca0de 100644 --- a/classes/_openfeature_core.GenericEventEmitter.html +++ b/classes/_openfeature_core.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

Class GenericEventEmitter<E, AdditionalContext>Abstract

The GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included in the event details.

-

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Implements

Constructors

constructor +

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Implements

Constructors

constructor

Properties

_eventLogger? _handlers eventEmitter @@ -12,10 +12,10 @@ removeAllHandlers removeHandler setLogger -

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

_handlers: {
    PROVIDER_CONFIGURATION_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_ERROR: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_READY: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_STALE: WeakMap<EventHandler, EventHandler[]>;
} = ...

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

_handlers: {
    PROVIDER_CONFIGURATION_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_ERROR: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_READY: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_STALE: WeakMap<EventHandler, EventHandler[]>;
} = ...

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.InvalidContextError.html b/classes/_openfeature_core.InvalidContextError.html index 7583c2f21..171fbac90 100644 --- a/classes/_openfeature_core.InvalidContextError.html +++ b/classes/_openfeature_core.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_core.OpenFeatureCommonAPI.html b/classes/_openfeature_core.OpenFeatureCommonAPI.html index e31bc0202..540a24921 100644 --- a/classes/_openfeature_core.OpenFeatureCommonAPI.html +++ b/classes/_openfeature_core.OpenFeatureCommonAPI.html @@ -1,4 +1,4 @@ -OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Implements

Constructors

constructor

Properties

_clientEventHandlers _clientEvents _context @@ -31,60 +31,60 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

_clientEventHandlers: Map<undefined | string, [AnyProviderEvent, EventHandler][]> = ...

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, P> = ...

Protected Abstract Readonly _events

_events: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

_clientEventHandlers: Map<undefined | string, [AnyProviderEvent, EventHandler][]> = ...

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, P> = ...

Protected Abstract Readonly _events

_events: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

  • addHandler<T>(eventType, handler): void

  • Adds 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.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): this

  • 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.

    Parameters

    • Rest ...hooks: H[]

      A list of hooks that should always run

    Returns this

    The receiver (this object)

    -

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

  • getProviderMetadata(domain?): ProviderMetadata

  • Get metadata about a registered provider using the client name. An unbound or empty client name will return metadata from the default provider.

    Parameters

    • Optional domain: string

      An identifier which logically binds clients with providers

    Returns ProviderMetadata

    Provider Metadata

    -

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

  • setAwaitableProvider(domainOrProvider?, providerOrUndefined?): void | Promise<void>

  • Parameters

    • Optional domainOrProvider: string | P
    • Optional providerOrUndefined: P

    Returns void | Promise<void>

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Returns void

Private setAwaitableProvider

  • setAwaitableProvider(domainOrProvider?, providerOrUndefined?): void | Promise<void>

  • Parameters

    • Optional domainOrProvider: string | P
    • Optional providerOrUndefined: P

    Returns void | Promise<void>

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default 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.

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

    -
  • setProvider(domain, provider): this

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +

  • setProvider(domain, provider): this

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • provider: P

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

    -

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. +

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default 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.

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

    -
  • setProviderAndWait(domain, provider): Promise<void>

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +

  • setProviderAndWait(domain, provider): Promise<void>

  • 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 in the same domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • provider: P

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

    -

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.OpenFeatureError.html b/classes/_openfeature_core.OpenFeatureError.html index f5b616575..f2acb6f19 100644 --- a/classes/_openfeature_core.OpenFeatureError.html +++ b/classes/_openfeature_core.OpenFeatureError.html @@ -1,4 +1,4 @@ -OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_core.ParseError.html b/classes/_openfeature_core.ParseError.html index 63d45e73a..cd47dfa8c 100644 --- a/classes/_openfeature_core.ParseError.html +++ b/classes/_openfeature_core.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_core.ProviderNotReadyError.html b/classes/_openfeature_core.ProviderNotReadyError.html index cf058b95e..a3dd16a46 100644 --- a/classes/_openfeature_core.ProviderNotReadyError.html +++ b/classes/_openfeature_core.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_core.SafeLogger.html b/classes/_openfeature_core.SafeLogger.html index f8a01c292..36a615cce 100644 --- a/classes/_openfeature_core.SafeLogger.html +++ b/classes/_openfeature_core.SafeLogger.html @@ -1,4 +1,4 @@ -SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor +SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor

Properties

fallbackLogger logger

Methods

debug @@ -6,4 +6,4 @@ info log warn -

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.TargetingKeyMissingError.html b/classes/_openfeature_core.TargetingKeyMissingError.html index 55e5c8a79..4c0b7329f 100644 --- a/classes/_openfeature_core.TargetingKeyMissingError.html +++ b/classes/_openfeature_core.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_core.TypeMismatchError.html b/classes/_openfeature_core.TypeMismatchError.html index f56c217d3..ea9b1e3c7 100644 --- a/classes/_openfeature_core.TypeMismatchError.html +++ b/classes/_openfeature_core.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.DefaultLogger.html b/classes/_openfeature_server_sdk.DefaultLogger.html index 07cd6e950..b62316a62 100644 --- a/classes/_openfeature_server_sdk.DefaultLogger.html +++ b/classes/_openfeature_server_sdk.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor +DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor

Methods

debug error info warn -

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.FlagNotFoundError.html b/classes/_openfeature_server_sdk.FlagNotFoundError.html index 705f39ed1..b52dc2ba8 100644 --- a/classes/_openfeature_server_sdk.FlagNotFoundError.html +++ b/classes/_openfeature_server_sdk.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.GeneralError.html b/classes/_openfeature_server_sdk.GeneralError.html index 1ea1d583c..5147988b8 100644 --- a/classes/_openfeature_server_sdk.GeneralError.html +++ b/classes/_openfeature_server_sdk.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.GenericEventEmitter.html b/classes/_openfeature_server_sdk.GenericEventEmitter.html index d0563a487..49d24e015 100644 --- a/classes/_openfeature_server_sdk.GenericEventEmitter.html +++ b/classes/_openfeature_server_sdk.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

Class GenericEventEmitter<E, AdditionalContext>Abstract

The GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included in the event details.

-

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_eventLogger? _handlers eventEmitter @@ -12,10 +12,10 @@ removeAllHandlers removeHandler setLogger -

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

_handlers: {
    PROVIDER_CONFIGURATION_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_ERROR: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_READY: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_STALE: WeakMap<EventHandler, EventHandler[]>;
} = ...

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

_handlers: {
    PROVIDER_CONFIGURATION_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_ERROR: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_READY: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_STALE: WeakMap<EventHandler, EventHandler[]>;
} = ...

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.InMemoryProvider.html b/classes/_openfeature_server_sdk.InMemoryProvider.html index 5ee41f58e..741942c74 100644 --- a/classes/_openfeature_server_sdk.InMemoryProvider.html +++ b/classes/_openfeature_server_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

Class InMemoryProvider

A simple OpenFeature provider intended for demos and as a test stub.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_flagConfiguration events metadata @@ -11,14 +11,14 @@ resolveNumberEvaluation resolveObjectEvaluation resolveStringEvaluation -

Constructors

constructor

Properties

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

+

Constructors

constructor

Properties

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: {
    name: "in-memory";
} = ...

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "server" = 'server'

Represents where the provider is intended to be run. If defined, +

Readonly metadata

metadata: {
    name: "in-memory";
} = ...

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "server" = 'server'

Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

-

Methods

Private lookupFlagValue

putConfiguration

Methods

Private lookupFlagValue

putConfiguration

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.InvalidContextError.html b/classes/_openfeature_server_sdk.InvalidContextError.html index c908ce54c..07752eef2 100644 --- a/classes/_openfeature_server_sdk.InvalidContextError.html +++ b/classes/_openfeature_server_sdk.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.OpenFeatureAPI.html b/classes/_openfeature_server_sdk.OpenFeatureAPI.html index 0ce6fbf3c..65127f5bc 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureAPI.html +++ b/classes/_openfeature_server_sdk.OpenFeatureAPI.html @@ -1,4 +1,4 @@ -OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_clientEvents _context _defaultProvider @@ -34,31 +34,31 @@ setProviderAndWait setTransactionContext setTransactionContextPropagator -

Constructors

Private constructor

Properties

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, Provider> = ...

Protected _events

_events: OpenFeatureEventEmitter = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, Provider> = ...

Protected _events

_events: OpenFeatureEventEmitter = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

providerMetadata

Methods

Protected _createEventEmitter

addHandler

Methods

Protected _createEventEmitter

addHandler

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): this

  • 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.

    Parameters

    • Rest ...hooks: Hook[]

      A list of hooks that should always run

    Returns this

    The receiver (this object)

    -

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

  • getClient(context?): Client

  • A 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.

    Parameters

    • Optional context: EvaluationContext

      Evaluation context that should be set on the client to used during flag evaluations

    Returns Client

    OpenFeature Client

    -
  • getClient(domain, context?): Client

  • A factory function for creating new domain scoped OpenFeature clients. +

  • getClient(domain, context?): 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. @@ -66,7 +66,7 @@

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • Optional context: EvaluationContext

      Evaluation context that should be set on the client to used during flag evaluations

    Returns Client

    OpenFeature Client

    -
  • getClient(domain, version, context?): Client

  • A factory function for creating new domain scoped OpenFeature clients. +

  • getClient(domain, version, context?): 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. @@ -75,68 +75,68 @@

  • version: string

    The version of the client (only used for metadata)

  • Optional context: EvaluationContext

    Evaluation context that should be set on the client to used during flag evaluations

Returns Client

OpenFeature Client

-

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

getTransactionContext

getTransactionContext

removeHandler

removeHandler

setContext

  • setContext(context): this

  • Sets evaluation context that will be used during flag evaluations +

Returns void

setContext

setLogger

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default 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.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

    -
  • setProvider(domain, provider): this

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +

  • setProvider(domain, provider): this

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

    -

setProviderAndWait

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default 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.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

    -
  • setProviderAndWait(domain, provider): Promise<void>

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +

  • setProviderAndWait(domain, provider): Promise<void>

  • 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 in the same domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

    -

setTransactionContext

setTransactionContext

  • setTransactionContext<R>(transactionContext, callback, ...args): void
  • Experimental

    EXPERIMENTAL: Transaction context propagation is experimental and subject to change. The OpenFeature Enhancement Proposal regarding transaction context can be found here.

    Sets the transaction context using the registered transaction context propagator.

    Type Parameters

    • R

      The return value of the callback

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

    • callback: ((...args) => R)

      Callback function used to set the transaction context on the stack

        • (...args): R

        • Parameters

          • Rest ...args: unknown[]

          Returns R

    • Rest ...args: unknown[]

      Optional arguments that are passed to the callback function

      -

    Returns void

setTransactionContextPropagator

  • setTransactionContextPropagator(transactionContextPropagator): OpenFeatureCommonAPI<Provider, BaseHook<FlagValue, unknown, unknown>>
  • Experimental

    EXPERIMENTAL: Transaction context propagation is experimental and subject to change. +

Returns void

setTransactionContextPropagator

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureClient.html b/classes/_openfeature_server_sdk.OpenFeatureClient.html index 85361863b..5d73bb2a7 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureClient.html +++ b/classes/_openfeature_server_sdk.OpenFeatureClient.html @@ -1,4 +1,4 @@ -OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor +OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor

Properties

_clientLogger? _context _hooks @@ -31,85 +31,85 @@ removeHandler setContext setLogger -

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _context

_context: EvaluationContext

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

Methods

addHandler

  • addHandler(eventType, handler): void

  • Adds a handler for the given provider event type. +

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _context

_context: EvaluationContext

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

Methods

addHandler

addHooks

  • addHooks(...hooks): OpenFeatureClient

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): OpenFeatureClient

  • 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.

    Parameters

    • Rest ...hooks: Hook[]

      A list of hooks that should always run

    Returns OpenFeatureClient

    The receiver (this object)

    -

Private afterHooks

Private beforeHooks

clearHooks

Private afterHooks

Private beforeHooks

clearHooks

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

getBooleanValue

getBooleanValue

  • getBooleanValue(flagKey, defaultValue, context?, options?): Promise<boolean>

  • Performs a flag evaluation that returns a boolean.

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

    • defaultValue: boolean

      The value returned if an error occurs

    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<boolean>

    Flag evaluation response

    -

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

  • getNumberValue<T>(flagKey, defaultValue, context?, options?): Promise<T>

  • Performs a flag evaluation that returns a number.

    Type Parameters

    • T extends number = number

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

    • defaultValue: T

      The value returned if an error occurs

    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<T>

    Flag evaluation response

    -

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

  • getStringValue<T>(flagKey, defaultValue, context?, options?): Promise<T>

  • Performs a flag evaluation that returns a string.

    Type Parameters

    • T extends string = string

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

    • defaultValue: T

      The value returned if an error occurs

    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<T>

    Flag evaluation response

    -

removeHandler

removeHandler

setContext

  • setContext(context): OpenFeatureClient

  • Sets evaluation context that will be used during flag evaluations +

Returns void

setContext

setLogger

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html b/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html index 8d533fdc7..1046ad9f6 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html +++ b/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html @@ -1,4 +1,4 @@ -OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_clientEventHandlers _clientEvents _context @@ -31,60 +31,60 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

_clientEventHandlers: Map<undefined | string, [AnyProviderEvent, EventHandler][]> = ...

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, P> = ...

Protected Abstract Readonly _events

_events: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

_clientEventHandlers: Map<undefined | string, [AnyProviderEvent, EventHandler][]> = ...

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, P> = ...

Protected Abstract Readonly _events

_events: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

  • addHandler<T>(eventType, handler): void

  • Adds 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.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): this

  • 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.

    Parameters

    • Rest ...hooks: H[]

      A list of hooks that should always run

    Returns this

    The receiver (this object)

    -

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

  • getProviderMetadata(domain?): ProviderMetadata

  • Get metadata about a registered provider using the client name. An unbound or empty client name will return metadata from the default provider.

    Parameters

    • Optional domain: string

      An identifier which logically binds clients with providers

    Returns ProviderMetadata

    Provider Metadata

    -

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

  • setAwaitableProvider(domainOrProvider?, providerOrUndefined?): void | Promise<void>

  • Parameters

    • Optional domainOrProvider: string | P
    • Optional providerOrUndefined: P

    Returns void | Promise<void>

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Returns void

Private setAwaitableProvider

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureError.html b/classes/_openfeature_server_sdk.OpenFeatureError.html index f376ae517..4e5675c4e 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureError.html +++ b/classes/_openfeature_server_sdk.OpenFeatureError.html @@ -1,4 +1,4 @@ -OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html index 1ffa4e016..409319f88 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html +++ b/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html @@ -2,7 +2,7 @@ events at various parts of the provider lifecycle.

NOTE: Ready and error events are automatically emitted by the SDK based on the result of the initialize method.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

eventEmitter

Accessors

_logger

Methods

addHandler @@ -11,10 +11,10 @@ removeAllHandlers removeHandler setLogger -

Constructors

constructor

Properties

Protected Readonly eventEmitter

eventEmitter: EventEmitter = ...

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Constructors

constructor

Properties

Protected Readonly eventEmitter

eventEmitter: EventEmitter = ...

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ParseError.html b/classes/_openfeature_server_sdk.ParseError.html index c0885bf93..9cd2e044f 100644 --- a/classes/_openfeature_server_sdk.ParseError.html +++ b/classes/_openfeature_server_sdk.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.ProviderNotReadyError.html b/classes/_openfeature_server_sdk.ProviderNotReadyError.html index a7760a9b8..f80a0dcfe 100644 --- a/classes/_openfeature_server_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_server_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.SafeLogger.html b/classes/_openfeature_server_sdk.SafeLogger.html index db6a4102a..8b0ce2ba2 100644 --- a/classes/_openfeature_server_sdk.SafeLogger.html +++ b/classes/_openfeature_server_sdk.SafeLogger.html @@ -1,4 +1,4 @@ -SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor +SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor

Properties

fallbackLogger logger

Methods

debug @@ -6,4 +6,4 @@ info log warn -

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.TargetingKeyMissingError.html b/classes/_openfeature_server_sdk.TargetingKeyMissingError.html index de4b34992..cea47c330 100644 --- a/classes/_openfeature_server_sdk.TargetingKeyMissingError.html +++ b/classes/_openfeature_server_sdk.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_server_sdk.TypeMismatchError.html b/classes/_openfeature_server_sdk.TypeMismatchError.html index 46d0b0e1a..bb1bc0ddc 100644 --- a/classes/_openfeature_server_sdk.TypeMismatchError.html +++ b/classes/_openfeature_server_sdk.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.DefaultLogger.html b/classes/_openfeature_web_sdk.DefaultLogger.html index 5b571a202..8a34a4f41 100644 --- a/classes/_openfeature_web_sdk.DefaultLogger.html +++ b/classes/_openfeature_web_sdk.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor +DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor

Methods

debug error info warn -

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.FlagNotFoundError.html b/classes/_openfeature_web_sdk.FlagNotFoundError.html index 5c5359396..ef3bdc432 100644 --- a/classes/_openfeature_web_sdk.FlagNotFoundError.html +++ b/classes/_openfeature_web_sdk.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.GeneralError.html b/classes/_openfeature_web_sdk.GeneralError.html index 7ed2e7e17..bbfabb180 100644 --- a/classes/_openfeature_web_sdk.GeneralError.html +++ b/classes/_openfeature_web_sdk.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.GenericEventEmitter.html b/classes/_openfeature_web_sdk.GenericEventEmitter.html index 991363be1..6920e9351 100644 --- a/classes/_openfeature_web_sdk.GenericEventEmitter.html +++ b/classes/_openfeature_web_sdk.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

Class GenericEventEmitter<E, AdditionalContext>Abstract

The GenericEventEmitter should only be used within the SDK. It supports additional properties that can be included in the event details.

-

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_eventLogger? _handlers eventEmitter @@ -12,10 +12,10 @@ removeAllHandlers removeHandler setLogger -

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

_handlers: {
    PROVIDER_CONFIGURATION_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_ERROR: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_READY: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_STALE: WeakMap<EventHandler, EventHandler[]>;
} = ...

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

_handlers: {
    PROVIDER_CONFIGURATION_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_ERROR: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_READY: WeakMap<EventHandler, EventHandler[]>;
    PROVIDER_STALE: WeakMap<EventHandler, EventHandler[]>;
} = ...

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.InMemoryProvider.html b/classes/_openfeature_web_sdk.InMemoryProvider.html index b54f6f2ce..013953c5e 100644 --- a/classes/_openfeature_web_sdk.InMemoryProvider.html +++ b/classes/_openfeature_web_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

Class InMemoryProvider

A simple OpenFeature provider intended for demos and as a test stub.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_context _flagConfiguration events @@ -15,24 +15,24 @@ resolveNumberEvaluation resolveObjectEvaluation resolveStringEvaluation -

Constructors

constructor

Properties

Private _context

_context: undefined | EvaluationContext

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

+

Constructors

constructor

Properties

Private _context

_context: undefined | EvaluationContext

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: {
    name: "in-memory";
} = ...

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "client" = 'client'

Represents where the provider is intended to be run. If defined, +

Readonly metadata

metadata: {
    name: "in-memory";
} = ...

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "client" = 'client'

Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

-

status

status: ProviderStatus = ProviderStatus.NOT_READY

Returns a representation of the current readiness of the provider. +

status

status: ProviderStatus = ProviderStatus.NOT_READY

Returns a representation of the current readiness of the provider. If the provider needs to be initialized, it should return ProviderStatus.READY. If the provider is in an error state, it should return ProviderStatus.ERROR. If the provider is functioning normally, it should return ProviderStatus.NOT_READY.

Providers which do not implement this method are assumed to be ready immediately.

-

Methods

initialize

Methods

initialize

Private lookupFlagValue

putConfiguration

Private lookupFlagValue

putConfiguration

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.InvalidContextError.html b/classes/_openfeature_web_sdk.InvalidContextError.html index 5c88e4c26..ae27815a8 100644 --- a/classes/_openfeature_web_sdk.InvalidContextError.html +++ b/classes/_openfeature_web_sdk.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.OpenFeatureAPI.html b/classes/_openfeature_web_sdk.OpenFeatureAPI.html index 087507d1a..d519790e6 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureAPI.html +++ b/classes/_openfeature_web_sdk.OpenFeatureAPI.html @@ -1,4 +1,4 @@ -OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_clientEvents _context _defaultProvider @@ -33,30 +33,30 @@ setLogger setProvider setProviderAndWait -

Constructors

Private constructor

Properties

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, Provider> = ...

Protected _events

_events: GenericEventEmitter<ProviderEvents, Record<string, unknown>> = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, Provider> = ...

Protected _events

_events: GenericEventEmitter<ProviderEvents, Record<string, unknown>> = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected _createEventEmitter

addHandler

Methods

Protected _createEventEmitter

addHandler

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): this

  • 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.

    Parameters

    • Rest ...hooks: Hook[]

      A list of hooks that should always run

    Returns this

    The receiver (this object)

    -

Protected buildAndCacheEventEmitterForClient

clearContext

Protected buildAndCacheEventEmitterForClient

clearContext

  • clearContext(): Promise<void>

  • Resets the global evaluation context to an empty object.

    +

    Returns Promise<void>

  • clearContext(domain): Promise<void>

  • Removes the evaluation context for a specific named client.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

      -

    Returns Promise<void>

clearContexts

  • clearContexts(): Promise<void>

  • Resets the global evaluation context and removes the evaluation context for +

Returns Promise<void>

clearContexts

clearHandlers

clearHooks

clearHandlers

clearHooks

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

  • getClient(domain?, version?): Client

  • A 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,60 +64,60 @@

    Parameters

    • Optional domain: string

      An identifier which logically binds clients with providers

    • Optional version: string

      The version of the client (only used for metadata)

    Returns Client

    OpenFeature Client

    -

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

removeHandler

removeHandler

Private runProviderContextChangeHandler

setContext

  • setContext(context): Promise<void>

  • Sets the evaluation context globally. +

Returns void

Private runProviderContextChangeHandler

setContext

  • setContext(context): Promise<void>

  • Sets the evaluation context globally. This will be used by all providers that have not bound to a domain.

    Parameters

    Returns Promise<void>

    Example

    await OpenFeature.setContext({ region: "us" });
    -
  • setContext(domain, context): Promise<void>

  • Sets the evaluation context for a specific provider. +

  • setContext(domain, context): Promise<void>

  • Sets the evaluation context for a specific provider. This will only affect providers bound to a domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • context: EvaluationContext

      Evaluation context

    Returns Promise<void>

    Example

    await OpenFeature.setContext("test", { scope: "provider" });
    OpenFeature.setProvider(new MyProvider()) // Uses the default context
    OpenFeature.setProvider("test", new MyProvider()) // Uses context: { scope: "provider" }
    -

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default 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.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

    -
  • setProvider(domain, provider): this

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +

  • setProvider(domain, provider): this

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns this

    OpenFeature API

    -

setProviderAndWait

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default 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.

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

    -
  • setProviderAndWait(domain, provider): Promise<void>

  • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. +

  • setProviderAndWait(domain, provider): Promise<void>

  • 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 in the same domain.

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • provider: Provider

      The provider responsible for flag evaluations.

    Returns Promise<void>

    Throws

    Uncaught exceptions thrown by the provider during initialization.

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureClient.html b/classes/_openfeature_web_sdk.OpenFeatureClient.html index 082bcaa3c..3f1cee612 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureClient.html +++ b/classes/_openfeature_web_sdk.OpenFeatureClient.html @@ -1,4 +1,4 @@ -OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor +OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor

Properties

_clientLogger? _hooks emitterAccessor @@ -29,72 +29,72 @@ getStringValue removeHandler setLogger -

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

providerStatus

Methods

addHandler

  • addHandler(eventType, handler): void

  • Adds a handler for the given provider event type. +

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

providerStatus

Methods

addHandler

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): this

  • 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.

    Parameters

    • Rest ...hooks: Hook[]

      A list of hooks that should always run

    Returns this

    The receiver (this object)

    -

Private afterHooks

Private beforeHooks

clearHooks

Private afterHooks

Private beforeHooks

clearHooks

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

getBooleanValue

getBooleanValue

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

removeHandler

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Returns void

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureCommonAPI.html b/classes/_openfeature_web_sdk.OpenFeatureCommonAPI.html index ab157e3be..6bb16e651 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureCommonAPI.html +++ b/classes/_openfeature_web_sdk.OpenFeatureCommonAPI.html @@ -1,4 +1,4 @@ -OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_clientEventHandlers _clientEvents _context @@ -31,60 +31,60 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

_clientEventHandlers: Map<undefined | string, [AnyProviderEvent, EventHandler][]> = ...

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, P> = ...

Protected Abstract Readonly _events

_events: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

_clientEventHandlers: Map<undefined | string, [AnyProviderEvent, EventHandler][]> = ...

Protected _clientEvents

_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected _domainScopedContext

_domainScopedContext: Map<string, EvaluationContext> = ...

Protected _domainScopedProviders

_domainScopedProviders: Map<string, P> = ...

Protected Abstract Readonly _events

_events: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

  • addHandler<T>(eventType, handler): void

  • Adds 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.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): this

  • 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.

    Parameters

    • Rest ...hooks: H[]

      A list of hooks that should always run

    Returns this

    The receiver (this object)

    -

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

  • getProviderMetadata(domain?): ProviderMetadata

  • Get metadata about a registered provider using the client name. An unbound or empty client name will return metadata from the default provider.

    Parameters

    • Optional domain: string

      An identifier which logically binds clients with providers

    Returns ProviderMetadata

    Provider Metadata

    -

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

  • setAwaitableProvider(domainOrProvider?, providerOrUndefined?): void | Promise<void>

  • Parameters

    • Optional domainOrProvider: string | P
    • Optional providerOrUndefined: P

    Returns void | Promise<void>

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Returns void

Private setAwaitableProvider

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureError.html b/classes/_openfeature_web_sdk.OpenFeatureError.html index 4561b09d3..b83827b43 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureError.html +++ b/classes/_openfeature_web_sdk.OpenFeatureError.html @@ -1,4 +1,4 @@ -OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html index 7cbadf7b3..8215e4011 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html +++ b/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html @@ -2,7 +2,7 @@ events at various parts of the provider lifecycle.

NOTE: Ready and error events are automatically emitted by the SDK based on the result of the initialize method.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

eventEmitter

Accessors

_logger

Methods

addHandler @@ -11,10 +11,10 @@ removeAllHandlers removeHandler setLogger -

Constructors

constructor

Properties

Protected Readonly eventEmitter

eventEmitter: EventEmitter = ...

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger +

Constructors

constructor

Properties

Protected Readonly eventEmitter

eventEmitter: EventEmitter = ...

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns this

    The receiver (this object)

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ParseError.html b/classes/_openfeature_web_sdk.ParseError.html index 04ebfa06f..577ef32de 100644 --- a/classes/_openfeature_web_sdk.ParseError.html +++ b/classes/_openfeature_web_sdk.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.ProviderNotReadyError.html b/classes/_openfeature_web_sdk.ProviderNotReadyError.html index 8c0680c17..88e3c8b91 100644 --- a/classes/_openfeature_web_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_web_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.SafeLogger.html b/classes/_openfeature_web_sdk.SafeLogger.html index 49a32c4aa..b4e3adeed 100644 --- a/classes/_openfeature_web_sdk.SafeLogger.html +++ b/classes/_openfeature_web_sdk.SafeLogger.html @@ -1,4 +1,4 @@ -SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor +SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor

Properties

fallbackLogger logger

Methods

debug @@ -6,4 +6,4 @@ info log warn -

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html index 3baf744f0..95eeef909 100644 --- a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html +++ b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/classes/_openfeature_web_sdk.TypeMismatchError.html b/classes/_openfeature_web_sdk.TypeMismatchError.html index 1f90bd3f7..5a787af9f 100644 --- a/classes/_openfeature_web_sdk.TypeMismatchError.html +++ b/classes/_openfeature_web_sdk.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor

Properties

cause? code message @@ -7,7 +7,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

diff --git a/enums/_openfeature_core.ClientProviderEvents.html b/enums/_openfeature_core.ClientProviderEvents.html index d2be53b29..a5b29763f 100644 --- a/enums/_openfeature_core.ClientProviderEvents.html +++ b/enums/_openfeature_core.ClientProviderEvents.html @@ -1,12 +1,12 @@ ClientProviderEvents | Documentation

Enumeration ClientProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

The flag configuration in the source-of-truth has changed.

-

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

The context associated with the provider has changed, and the provider has reconciled it's associated state.

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

The context associated with the provider has changed, and the provider has reconciled it's associated state.

+

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ErrorCode.html b/enums/_openfeature_core.ErrorCode.html index 0705a9b79..932f35dd3 100644 --- a/enums/_openfeature_core.ErrorCode.html +++ b/enums/_openfeature_core.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND GENERAL INVALID_CONTEXT PARSE_ERROR @@ -6,10 +6,10 @@ TARGETING_KEY_MISSING TYPE_MISMATCH

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

An error was encountered parsing data, such as a flag configuration.

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

The provider requires a targeting key and one was not provided in the evaluation context.

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

The type of the flag value does not match the expected type.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

An error was encountered parsing data, such as a flag configuration.

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

The provider requires a targeting key and one was not provided in the evaluation context.

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

The type of the flag value does not match the expected type.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ProviderStatus.html b/enums/_openfeature_core.ProviderStatus.html index 8ae200806..8ad209436 100644 --- a/enums/_openfeature_core.ProviderStatus.html +++ b/enums/_openfeature_core.ProviderStatus.html @@ -1,10 +1,10 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

The provider is in an error state and unable to evaluate flags.

-

NOT_READY

NOT_READY: "NOT_READY"

The provider has not been initialized and cannot yet evaluate flags.

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

NOT_READY

NOT_READY: "NOT_READY"

The provider has not been initialized and cannot yet evaluate flags.

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ServerProviderEvents.html b/enums/_openfeature_core.ServerProviderEvents.html index a4545bfb0..688bebcbc 100644 --- a/enums/_openfeature_core.ServerProviderEvents.html +++ b/enums/_openfeature_core.ServerProviderEvents.html @@ -1,10 +1,10 @@ ServerProviderEvents | Documentation

Enumeration ServerProviderEvents

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

The flag configuration in the source-of-truth has changed.

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ClientProviderEvents.html b/enums/_openfeature_server_sdk.ClientProviderEvents.html index e869c4075..d76b32264 100644 --- a/enums/_openfeature_server_sdk.ClientProviderEvents.html +++ b/enums/_openfeature_server_sdk.ClientProviderEvents.html @@ -1,12 +1,12 @@ ClientProviderEvents | Documentation

Enumeration ClientProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

The flag configuration in the source-of-truth has changed.

-

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

The context associated with the provider has changed, and the provider has reconciled it's associated state.

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

The context associated with the provider has changed, and the provider has reconciled it's associated state.

+

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ErrorCode.html b/enums/_openfeature_server_sdk.ErrorCode.html index 41adb5ff5..4b6212703 100644 --- a/enums/_openfeature_server_sdk.ErrorCode.html +++ b/enums/_openfeature_server_sdk.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND GENERAL INVALID_CONTEXT PARSE_ERROR @@ -6,10 +6,10 @@ TARGETING_KEY_MISSING TYPE_MISMATCH

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

An error was encountered parsing data, such as a flag configuration.

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

The provider requires a targeting key and one was not provided in the evaluation context.

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

The type of the flag value does not match the expected type.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

An error was encountered parsing data, such as a flag configuration.

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

The provider requires a targeting key and one was not provided in the evaluation context.

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

The type of the flag value does not match the expected type.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ProviderEvents.html b/enums/_openfeature_server_sdk.ProviderEvents.html index 36b9edbc2..28816055c 100644 --- a/enums/_openfeature_server_sdk.ProviderEvents.html +++ b/enums/_openfeature_server_sdk.ProviderEvents.html @@ -1,10 +1,10 @@ ProviderEvents | Documentation

Enumeration ProviderEvents

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

The flag configuration in the source-of-truth has changed.

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ProviderStatus.html b/enums/_openfeature_server_sdk.ProviderStatus.html index a5c9756ba..6363175e4 100644 --- a/enums/_openfeature_server_sdk.ProviderStatus.html +++ b/enums/_openfeature_server_sdk.ProviderStatus.html @@ -1,10 +1,10 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

The provider is in an error state and unable to evaluate flags.

-

NOT_READY

NOT_READY: "NOT_READY"

The provider has not been initialized and cannot yet evaluate flags.

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

NOT_READY

NOT_READY: "NOT_READY"

The provider has not been initialized and cannot yet evaluate flags.

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ErrorCode.html b/enums/_openfeature_web_sdk.ErrorCode.html index 2a065f608..4489ed015 100644 --- a/enums/_openfeature_web_sdk.ErrorCode.html +++ b/enums/_openfeature_web_sdk.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND GENERAL INVALID_CONTEXT PARSE_ERROR @@ -6,10 +6,10 @@ TARGETING_KEY_MISSING TYPE_MISMATCH

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

An error was encountered parsing data, such as a flag configuration.

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

The provider requires a targeting key and one was not provided in the evaluation context.

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

The type of the flag value does not match the expected type.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

An error was encountered parsing data, such as a flag configuration.

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

The provider requires a targeting key and one was not provided in the evaluation context.

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

The type of the flag value does not match the expected type.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ProviderEvents.html b/enums/_openfeature_web_sdk.ProviderEvents.html index 744ba7afa..5b0813091 100644 --- a/enums/_openfeature_web_sdk.ProviderEvents.html +++ b/enums/_openfeature_web_sdk.ProviderEvents.html @@ -1,12 +1,12 @@ ProviderEvents | Documentation

Enumeration ProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

The flag configuration in the source-of-truth has changed.

-

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

The context associated with the provider has changed, and the provider has reconciled it's associated state.

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

The context associated with the provider has changed, and the provider has reconciled it's associated state.

+

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ProviderStatus.html b/enums/_openfeature_web_sdk.ProviderStatus.html index e9fbf395f..102595677 100644 --- a/enums/_openfeature_web_sdk.ProviderStatus.html +++ b/enums/_openfeature_web_sdk.ProviderStatus.html @@ -1,10 +1,10 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

The provider is in an error state and unable to evaluate flags.

-

NOT_READY

NOT_READY: "NOT_READY"

The provider has not been initialized and cannot yet evaluate flags.

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

NOT_READY

NOT_READY: "NOT_READY"

The provider has not been initialized and cannot yet evaluate flags.

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ServerProviderEvents.html b/enums/_openfeature_web_sdk.ServerProviderEvents.html index e769555dd..7a2051e85 100644 --- a/enums/_openfeature_web_sdk.ServerProviderEvents.html +++ b/enums/_openfeature_web_sdk.ServerProviderEvents.html @@ -1,10 +1,10 @@ ServerProviderEvents | Documentation

Enumeration ServerProviderEvents

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

The flag configuration in the source-of-truth has changed.

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

The provider's cached state is no longer valid and may not be up-to-date with the source of truth.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.isObject.html b/functions/_openfeature_core.isObject.html index f25d8271b..01a71f749 100644 --- a/functions/_openfeature_core.isObject.html +++ b/functions/_openfeature_core.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation

Function isObject

  • isObject<T>(value): value is T

  • Checks whether the parameter is an object.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns value is T

    True if the value is an object

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.isString.html b/functions/_openfeature_core.isString.html index d32657798..0c869507f 100644 --- a/functions/_openfeature_core.isString.html +++ b/functions/_openfeature_core.isString.html @@ -1,4 +1,4 @@ isString | Documentation

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    Parameters

    • value: unknown

      The value to check

    Returns value is string

    True if the value is a string

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.objectOrUndefined.html b/functions/_openfeature_core.objectOrUndefined.html index 8c2a733f2..70af3fc15 100644 --- a/functions/_openfeature_core.objectOrUndefined.html +++ b/functions/_openfeature_core.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation

Function objectOrUndefined

  • objectOrUndefined<T>(value): T | undefined

  • Returns the parameter if it is an object, otherwise returns undefined.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns T | undefined

    The parameter if it is an object, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.statusMatchesEvent.html b/functions/_openfeature_core.statusMatchesEvent.html index 11774a3ee..b3ede4e08 100644 --- a/functions/_openfeature_core.statusMatchesEvent.html +++ b/functions/_openfeature_core.statusMatchesEvent.html @@ -3,4 +3,4 @@

Type Parameters

Parameters

Returns boolean

boolean indicating if the provider status corresponds to the event.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.stringOrUndefined.html b/functions/_openfeature_core.stringOrUndefined.html index 9027d2963..34977a2cc 100644 --- a/functions/_openfeature_core.stringOrUndefined.html +++ b/functions/_openfeature_core.stringOrUndefined.html @@ -1,4 +1,4 @@ stringOrUndefined | Documentation

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

  • Returns the parameter if it is a string, otherwise returns undefined.

    Parameters

    • value: unknown

      The value to check

    Returns string | undefined

    The parameter if it is a string, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.isObject.html b/functions/_openfeature_server_sdk.isObject.html index 8952520d2..0f0c85979 100644 --- a/functions/_openfeature_server_sdk.isObject.html +++ b/functions/_openfeature_server_sdk.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation

Function isObject

  • isObject<T>(value): value is T

  • Checks whether the parameter is an object.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns value is T

    True if the value is an object

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.isString.html b/functions/_openfeature_server_sdk.isString.html index be9b47eda..7102fa9c7 100644 --- a/functions/_openfeature_server_sdk.isString.html +++ b/functions/_openfeature_server_sdk.isString.html @@ -1,4 +1,4 @@ isString | Documentation

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    Parameters

    • value: unknown

      The value to check

    Returns value is string

    True if the value is a string

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.objectOrUndefined.html b/functions/_openfeature_server_sdk.objectOrUndefined.html index ac75a7dc0..6ed0c8d27 100644 --- a/functions/_openfeature_server_sdk.objectOrUndefined.html +++ b/functions/_openfeature_server_sdk.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation

Function objectOrUndefined

  • objectOrUndefined<T>(value): T | undefined

  • Returns the parameter if it is an object, otherwise returns undefined.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns T | undefined

    The parameter if it is an object, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.statusMatchesEvent.html b/functions/_openfeature_server_sdk.statusMatchesEvent.html index af05a3a76..1e6bd5bbc 100644 --- a/functions/_openfeature_server_sdk.statusMatchesEvent.html +++ b/functions/_openfeature_server_sdk.statusMatchesEvent.html @@ -3,4 +3,4 @@

Type Parameters

Parameters

Returns boolean

boolean indicating if the provider status corresponds to the event.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.stringOrUndefined.html b/functions/_openfeature_server_sdk.stringOrUndefined.html index e0ef77fcc..f4953a79f 100644 --- a/functions/_openfeature_server_sdk.stringOrUndefined.html +++ b/functions/_openfeature_server_sdk.stringOrUndefined.html @@ -1,4 +1,4 @@ stringOrUndefined | Documentation

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

  • Returns the parameter if it is a string, otherwise returns undefined.

    Parameters

    • value: unknown

      The value to check

    Returns string | undefined

    The parameter if it is a string, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.isObject.html b/functions/_openfeature_web_sdk.isObject.html index 4bddebfcd..498699e7e 100644 --- a/functions/_openfeature_web_sdk.isObject.html +++ b/functions/_openfeature_web_sdk.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation

Function isObject

  • isObject<T>(value): value is T

  • Checks whether the parameter is an object.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns value is T

    True if the value is an object

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.isString.html b/functions/_openfeature_web_sdk.isString.html index 4598d0de1..3a3f550ba 100644 --- a/functions/_openfeature_web_sdk.isString.html +++ b/functions/_openfeature_web_sdk.isString.html @@ -1,4 +1,4 @@ isString | Documentation

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    Parameters

    • value: unknown

      The value to check

    Returns value is string

    True if the value is a string

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.objectOrUndefined.html b/functions/_openfeature_web_sdk.objectOrUndefined.html index 0715f0bef..399d1e51c 100644 --- a/functions/_openfeature_web_sdk.objectOrUndefined.html +++ b/functions/_openfeature_web_sdk.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation

Function objectOrUndefined

  • objectOrUndefined<T>(value): T | undefined

  • Returns the parameter if it is an object, otherwise returns undefined.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns T | undefined

    The parameter if it is an object, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.statusMatchesEvent.html b/functions/_openfeature_web_sdk.statusMatchesEvent.html index a95586ee6..d6651ceae 100644 --- a/functions/_openfeature_web_sdk.statusMatchesEvent.html +++ b/functions/_openfeature_web_sdk.statusMatchesEvent.html @@ -3,4 +3,4 @@

Type Parameters

Parameters

Returns boolean

boolean indicating if the provider status corresponds to the event.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.stringOrUndefined.html b/functions/_openfeature_web_sdk.stringOrUndefined.html index 6bb184623..dbce6dcdc 100644 --- a/functions/_openfeature_web_sdk.stringOrUndefined.html +++ b/functions/_openfeature_web_sdk.stringOrUndefined.html @@ -1,4 +1,4 @@ stringOrUndefined | Documentation

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

  • Returns the parameter if it is a string, otherwise returns undefined.

    Parameters

    • value: unknown

      The value to check

    Returns string | undefined

    The parameter if it is a string, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.BaseHook.html b/interfaces/_openfeature_core.BaseHook.html index cfaf4071f..7142bb4c7 100644 --- a/interfaces/_openfeature_core.BaseHook.html +++ b/interfaces/_openfeature_core.BaseHook.html @@ -1,11 +1,11 @@ -BaseHook | Documentation

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

interface BaseHook<T, BeforeHookReturn, HooksReturn> {
    after?(hookContext, evaluationDetails, hookHints?): HooksReturn;
    before?(hookContext, hookHints?): BeforeHookReturn;
    error?(hookContext, error, hookHints?): HooksReturn;
    finally?(hookContext, hookHints?): HooksReturn;
}

Type Parameters

Methods

after? +BaseHook | Documentation

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

interface BaseHook<T, BeforeHookReturn, HooksReturn> {
    after?(hookContext, evaluationDetails, hookHints?): HooksReturn;
    before?(hookContext, hookHints?): BeforeHookReturn;
    error?(hookContext, error, hookHints?): HooksReturn;
    finally?(hookContext, hookHints?): HooksReturn;
}

Type Parameters

Methods

after? before? error? finally?

Methods

Optional after

Optional before

Optional before

Optional error

Optional finally

Optional error

Optional finally

  • finally(hookContext, hookHints?): HooksReturn

  • Runs after all other hook stages, regardless of success or error. Errors thrown here are unhandled by the client and will surface in application code.

    -

    Parameters

    • hookContext: Readonly<HookContext<T>>
    • Optional hookHints: Readonly<Record<string, unknown>>

    Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • hookContext: Readonly<HookContext<T>>
  • Optional hookHints: Readonly<Record<string, unknown>>

Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.BeforeHookContext.html b/interfaces/_openfeature_core.BeforeHookContext.html index be95bd138..f1b647ee5 100644 --- a/interfaces/_openfeature_core.BeforeHookContext.html +++ b/interfaces/_openfeature_core.BeforeHookContext.html @@ -1,8 +1,8 @@ -BeforeHookContext | Documentation

Interface BeforeHookContext

interface BeforeHookContext {
    clientMetadata: ClientMetadata;
    context: EvaluationContext;
    defaultValue: FlagValue;
    flagKey: string;
    flagValueType: FlagValueType;
    logger: Logger;
    providerMetadata: ProviderMetadata;
}

Hierarchy (view full)

Properties

clientMetadata +BeforeHookContext | Documentation

Interface BeforeHookContext

interface BeforeHookContext {
    clientMetadata: ClientMetadata;
    context: EvaluationContext;
    defaultValue: FlagValue;
    flagKey: string;
    flagValueType: FlagValueType;
    logger: Logger;
    providerMetadata: ProviderMetadata;
}

Hierarchy (view full)

Properties

clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ClientMetadata.html b/interfaces/_openfeature_core.ClientMetadata.html index d34b2b883..6f945e517 100644 --- a/interfaces/_openfeature_core.ClientMetadata.html +++ b/interfaces/_openfeature_core.ClientMetadata.html @@ -1,6 +1,6 @@ -ClientMetadata | Documentation

Interface ClientMetadata

interface ClientMetadata {
    domain?: string;
    name?: string;
    providerMetadata: ProviderMetadata;
    version?: string;
}

Hierarchy (view full)

Properties

domain? +ClientMetadata | Documentation

Interface ClientMetadata

interface ClientMetadata {
    domain?: string;
    name?: string;
    providerMetadata: ProviderMetadata;
    version?: string;
}

Hierarchy (view full)

Properties

domain? name? providerMetadata version? -

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

-

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

+

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.CommonProvider.html b/interfaces/_openfeature_core.CommonProvider.html index 9901408c9..7e103c9df 100644 --- a/interfaces/_openfeature_core.CommonProvider.html +++ b/interfaces/_openfeature_core.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

Interface CommonProvider

interface CommonProvider {
    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
    metadata: ProviderMetadata;
    runsOn?: Paradigm;
    status?: ProviderStatus;
    initialize?(context?): Promise<void>;
    onClose?(): Promise<void>;
}

Properties

events? +CommonProvider | Documentation

Interface CommonProvider

interface CommonProvider {
    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
    metadata: ProviderMetadata;
    runsOn?: Paradigm;
    status?: ProviderStatus;
    initialize?(context?): Promise<void>;
    onClose?(): Promise<void>;
}

Properties

events? metadata runsOn? status? @@ -6,18 +6,18 @@ onClose?

Properties

Optional events

events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

Represents where the provider is intended to be run. If defined, +

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

-

Optional Readonly status

status?: ProviderStatus

Returns a representation of the current readiness of the provider. +

Optional Readonly status

status?: ProviderStatus

Returns a representation of the current readiness of the provider. If the provider needs to be initialized, it should return ProviderStatus.READY. If the provider is in an error state, it should return ProviderStatus.ERROR. If the provider is functioning normally, it should return ProviderStatus.NOT_READY.

Providers which do not implement this method are assumed to be ready immediately.

-

Methods

Optional initialize

Methods

Optional initialize

  • initialize(context?): Promise<void>

  • A function used to setup the provider. Called by the SDK after the provider is set if the provider's status is ProviderStatus.NOT_READY. When the returned promise resolves, the SDK fires the ProviderEvents.Ready event. If the returned promise rejects, the SDK fires the ProviderEvents.Error event. Use this function to perform any context-dependent setup within the provider.

    -

    Parameters

    Returns Promise<void>

Optional onClose

Optional onClose

  • onClose(): Promise<void>

  • A function used to shut down the provider. Called when this provider is replaced with a new one, or when the OpenFeature is shut down.

    -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.EvaluationLifeCycle.html b/interfaces/_openfeature_core.EvaluationLifeCycle.html index 2e7b9192a..188a98b1d 100644 --- a/interfaces/_openfeature_core.EvaluationLifeCycle.html +++ b/interfaces/_openfeature_core.EvaluationLifeCycle.html @@ -1,4 +1,4 @@ -EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

interface EvaluationLifeCycle<T> {
    addHooks(...hooks): T;
    clearHooks(): T;
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
}

Type Parameters

  • T

Implemented by

Methods

addHooks +EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

interface EvaluationLifeCycle<T> {
    addHooks(...hooks): T;
    clearHooks(): T;
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
}

Type Parameters

  • T

Implemented by

Methods

addHooks clearHooks getHooks

Methods

addHooks

  • addHooks(...hooks): T

  • Adds hooks that will run during flag evaluations on this receiver. @@ -8,8 +8,8 @@ Hooks registered on the client run with all evaluations on that client.

    Parameters

    • Rest ...hooks: BaseHook<FlagValue, unknown, unknown>[]

      A list of hooks that should always run

    Returns T

    The receiver (this object)

    -

clearHooks

clearHooks

getHooks

getHooks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.Eventing.html b/interfaces/_openfeature_core.Eventing.html index b4d3fbc3f..c69e3d777 100644 --- a/interfaces/_openfeature_core.Eventing.html +++ b/interfaces/_openfeature_core.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation

Interface Eventing

interface Eventing {
    addHandler(eventType, handler): void;
    getHandlers(eventType): EventHandler[];
    removeHandler(eventType, handler): void;
}

Implemented by

Methods

addHandler +Eventing | Documentation

Interface Eventing

interface Eventing {
    addHandler(eventType, handler): void;
    getHandlers(eventType): EventHandler[];
    removeHandler(eventType, handler): void;
}

Implemented by

Methods

addHandler getHandlers removeHandler

Methods

addHandler

  • addHandler(eventType, handler): void

  • Adds a handler for the given provider event type. The handlers are called in the order they have been added.

    Parameters

    Returns void

getHandlers

  • getHandlers(eventType): EventHandler[]

  • Gets the current handlers for the given provider event type.

    +

Returns void

getHandlers

removeHandler

removeHandler

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.HookContext.html b/interfaces/_openfeature_core.HookContext.html index 4160bfb1e..1b1bdc03f 100644 --- a/interfaces/_openfeature_core.HookContext.html +++ b/interfaces/_openfeature_core.HookContext.html @@ -1,8 +1,8 @@ -HookContext | Documentation

Interface HookContext<T>

interface HookContext<T> {
    clientMetadata: ClientMetadata;
    context: Readonly<EvaluationContext>;
    defaultValue: T;
    flagKey: string;
    flagValueType: FlagValueType;
    logger: Logger;
    providerMetadata: ProviderMetadata;
}

Type Parameters

Hierarchy (view full)

Properties

clientMetadata +HookContext | Documentation

Interface HookContext<T>

interface HookContext<T> {
    clientMetadata: ClientMetadata;
    context: Readonly<EvaluationContext>;
    defaultValue: T;
    flagKey: string;
    flagValueType: FlagValueType;
    logger: Logger;
    providerMetadata: ProviderMetadata;
}

Type Parameters

Hierarchy (view full)

Properties

clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

Readonly context

context: Readonly<EvaluationContext>

Readonly defaultValue

defaultValue: T

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

Readonly context

context: Readonly<EvaluationContext>

Readonly defaultValue

defaultValue: T

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.Logger.html b/interfaces/_openfeature_core.Logger.html index d77128a99..787630ff7 100644 --- a/interfaces/_openfeature_core.Logger.html +++ b/interfaces/_openfeature_core.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation

Interface Logger

interface Logger {
    debug(...args): void;
    error(...args): void;
    info(...args): void;
    warn(...args): void;
}

Implemented by

Methods

debug +Logger | Documentation

Interface Logger

interface Logger {
    debug(...args): void;
    error(...args): void;
    info(...args): void;
    warn(...args): void;
}

Implemented by

Methods

debug error info warn -

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ManageContext.html b/interfaces/_openfeature_core.ManageContext.html index 52f03b738..d469cb5b1 100644 --- a/interfaces/_openfeature_core.ManageContext.html +++ b/interfaces/_openfeature_core.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation

Interface ManageContext<T>

interface ManageContext<T> {
    getContext(): EvaluationContext;
    setContext(context): T;
}

Type Parameters

  • T

Methods

getContext +ManageContext | Documentation

Interface ManageContext<T>

interface ManageContext<T> {
    getContext(): EvaluationContext;
    setContext(context): T;
}

Type Parameters

  • T

Methods

getContext setContext

Methods

getContext

setContext

setContext

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ManageLogger.html b/interfaces/_openfeature_core.ManageLogger.html index 484ad114d..81f909e7a 100644 --- a/interfaces/_openfeature_core.ManageLogger.html +++ b/interfaces/_openfeature_core.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation

Interface ManageLogger<T>

interface ManageLogger<T> {
    setLogger(logger): T;
}

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

setLogger +ManageLogger | Documentation

Interface ManageLogger<T>

interface ManageLogger<T> {
    setLogger(logger): T;
}

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

setLogger

Methods

setLogger

  • setLogger(logger): T

  • 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.

    Parameters

    • logger: Logger

      The logger to be used

    Returns T

    The receiver (this object)

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.Metadata.html b/interfaces/_openfeature_core.Metadata.html index 57197a13d..80ffe6ca2 100644 --- a/interfaces/_openfeature_core.Metadata.html +++ b/interfaces/_openfeature_core.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

Interface Metadata

interface Metadata {}

Hierarchy (view full)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Metadata | Documentation

Interface Metadata

interface Metadata {}

Hierarchy (view full)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ProviderEventEmitter.html b/interfaces/_openfeature_core.ProviderEventEmitter.html index 2e3314ca0..7b6ec486b 100644 --- a/interfaces/_openfeature_core.ProviderEventEmitter.html +++ b/interfaces/_openfeature_core.ProviderEventEmitter.html @@ -1,16 +1,16 @@ ProviderEventEmitter | Documentation

Interface ProviderEventEmitter<E, AdditionalContext>

Event emitter to be optionally implemented by providers. Implemented by

See

OpenFeatureEventEmitter.

-
interface ProviderEventEmitter<E, AdditionalContext> {
    addHandler(eventType, handler): void;
    emit(eventType, context?): void;
    getHandlers(eventType): EventHandler[];
    removeAllHandlers(eventType?): void;
    removeHandler(eventType, handler): void;
    setLogger(logger): ProviderEventEmitter<E, AdditionalContext>;
}

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Hierarchy (view full)

Implemented by

Methods

addHandler +
interface ProviderEventEmitter<E, AdditionalContext> {
    addHandler(eventType, handler): void;
    emit(eventType, context?): void;
    getHandlers(eventType): EventHandler[];
    removeAllHandlers(eventType?): void;
    removeHandler(eventType, handler): void;
    setLogger(logger): ProviderEventEmitter<E, AdditionalContext>;
}

Type Parameters

  • E extends AnyProviderEvent

  • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

Hierarchy (view full)

Implemented by

Methods

addHandler emit getHandlers removeAllHandlers removeHandler setLogger -

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ProviderMetadata.html b/interfaces/_openfeature_core.ProviderMetadata.html index d2eaf5acc..a18e58da2 100644 --- a/interfaces/_openfeature_core.ProviderMetadata.html +++ b/interfaces/_openfeature_core.ProviderMetadata.html @@ -1,3 +1,3 @@ ProviderMetadata | Documentation

Interface ProviderMetadata

Static data about the provider.

-
interface ProviderMetadata {
    name: string;
}

Hierarchy (view full)

Properties

name -

Properties

Readonly name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +
interface ProviderMetadata {
    name: string;
}

Hierarchy (view full)

Properties

name +

Properties

Readonly name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.BaseHook.html b/interfaces/_openfeature_server_sdk.BaseHook.html index ba9a1dbdc..7d6aa225d 100644 --- a/interfaces/_openfeature_server_sdk.BaseHook.html +++ b/interfaces/_openfeature_server_sdk.BaseHook.html @@ -1,11 +1,11 @@ -BaseHook | Documentation

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

interface BaseHook<T, BeforeHookReturn, HooksReturn> {
    after?(hookContext, evaluationDetails, hookHints?): HooksReturn;
    before?(hookContext, hookHints?): BeforeHookReturn;
    error?(hookContext, error, hookHints?): HooksReturn;
    finally?(hookContext, hookHints?): HooksReturn;
}

Type Parameters

Methods

after? +BaseHook | Documentation

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

interface BaseHook<T, BeforeHookReturn, HooksReturn> {
    after?(hookContext, evaluationDetails, hookHints?): HooksReturn;
    before?(hookContext, hookHints?): BeforeHookReturn;
    error?(hookContext, error, hookHints?): HooksReturn;
    finally?(hookContext, hookHints?): HooksReturn;
}

Type Parameters

Methods

after? before? error? finally?

Methods

Optional after

Optional before

Optional before

Optional error

Optional finally

Optional error

Optional finally

  • finally(hookContext, hookHints?): HooksReturn

  • Runs after all other hook stages, regardless of success or error. Errors thrown here are unhandled by the client and will surface in application code.

    -

    Parameters

    • hookContext: Readonly<HookContext<T>>
    • Optional hookHints: Readonly<Record<string, unknown>>

    Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

  • hookContext: Readonly<HookContext<T>>
  • Optional hookHints: Readonly<Record<string, unknown>>

Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.BeforeHookContext.html b/interfaces/_openfeature_server_sdk.BeforeHookContext.html index f5e7d96f5..02320f900 100644 --- a/interfaces/_openfeature_server_sdk.BeforeHookContext.html +++ b/interfaces/_openfeature_server_sdk.BeforeHookContext.html @@ -1,8 +1,8 @@ -BeforeHookContext | Documentation

Interface BeforeHookContext

interface BeforeHookContext {
    clientMetadata: ClientMetadata;
    context: EvaluationContext;
    defaultValue: FlagValue;
    flagKey: string;
    flagValueType: FlagValueType;
    logger: Logger;
    providerMetadata: ProviderMetadata;
}

Hierarchy (view full)

Properties

clientMetadata +BeforeHookContext | Documentation

Interface BeforeHookContext

interface BeforeHookContext {
    clientMetadata: ClientMetadata;
    context: EvaluationContext;
    defaultValue: FlagValue;
    flagKey: string;
    flagValueType: FlagValueType;
    logger: Logger;
    providerMetadata: ProviderMetadata;
}

Hierarchy (view full)

Properties

clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Client.html b/interfaces/_openfeature_server_sdk.Client.html index 8e0da3507..3fcb411e2 100644 --- a/interfaces/_openfeature_server_sdk.Client.html +++ b/interfaces/_openfeature_server_sdk.Client.html @@ -1,4 +1,4 @@ -Client | Documentation

Interface Client

interface Client {
    metadata: ClientMetadata;
    addHandler(eventType, handler): void;
    addHooks(...hooks): Client;
    clearHooks(): Client;
    getBooleanDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<boolean>>;
    getBooleanValue(flagKey, defaultValue, context?, options?): Promise<boolean>;
    getContext(): EvaluationContext;
    getHandlers(eventType): EventHandler[];
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
    getNumberDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<number>>;
    getNumberDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getNumberValue(flagKey, defaultValue, context?, options?): Promise<number>;
    getNumberValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getObjectDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<JsonValue>>;
    getObjectDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getObjectValue(flagKey, defaultValue, context?, options?): Promise<JsonValue>;
    getObjectValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getStringDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<string>>;
    getStringDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getStringValue(flagKey, defaultValue, context?, options?): Promise<string>;
    getStringValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    removeHandler(eventType, handler): void;
    setContext(context): Client;
    setLogger(logger): Client;
}

Hierarchy (view full)

Implemented by

Properties

metadata +Client | Documentation

Interface Client

interface Client {
    metadata: ClientMetadata;
    addHandler(eventType, handler): void;
    addHooks(...hooks): Client;
    clearHooks(): Client;
    getBooleanDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<boolean>>;
    getBooleanValue(flagKey, defaultValue, context?, options?): Promise<boolean>;
    getContext(): EvaluationContext;
    getHandlers(eventType): EventHandler[];
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
    getNumberDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<number>>;
    getNumberDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getNumberValue(flagKey, defaultValue, context?, options?): Promise<number>;
    getNumberValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getObjectDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<JsonValue>>;
    getObjectDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getObjectValue(flagKey, defaultValue, context?, options?): Promise<JsonValue>;
    getObjectValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getStringDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<string>>;
    getStringDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getStringValue(flagKey, defaultValue, context?, options?): Promise<string>;
    getStringValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    removeHandler(eventType, handler): void;
    setContext(context): Client;
    setLogger(logger): Client;
}

Hierarchy (view full)

Implemented by

Properties

metadata

Methods

addHandler addHooks clearHooks @@ -16,85 +16,85 @@ removeHandler setContext setLogger -

Properties

Readonly metadata

metadata: ClientMetadata

Methods

addHandler

  • addHandler(eventType, handler): void

  • Adds a handler for the given provider event type. +

Properties

Readonly metadata

metadata: ClientMetadata

Methods

addHandler

addHooks

  • addHooks(...hooks): Client

  • Adds hooks that will run during flag evaluations on this receiver. +

Returns void

addHooks

  • addHooks(...hooks): Client

  • 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.

    Parameters

    • Rest ...hooks: BaseHook<FlagValue, unknown, unknown>[]

      A list of hooks that should always run

    Returns Client

    The receiver (this object)

    -

clearHooks

clearHooks

getBooleanDetails

getBooleanDetails

getBooleanValue

getBooleanValue

  • getBooleanValue(flagKey, defaultValue, context?, options?): Promise<boolean>

  • Performs a flag evaluation that returns a boolean.

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

    • defaultValue: boolean

      The value returned if an error occurs

    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<boolean>

    Flag evaluation response

    -

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

removeHandler

removeHandler

setContext

  • setContext(context): Client

  • Sets evaluation context that will be used during flag evaluations +

Returns void

setContext

setLogger

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ClientMetadata.html b/interfaces/_openfeature_server_sdk.ClientMetadata.html index f6d34f9f9..8a6a53def 100644 --- a/interfaces/_openfeature_server_sdk.ClientMetadata.html +++ b/interfaces/_openfeature_server_sdk.ClientMetadata.html @@ -1,6 +1,6 @@ -ClientMetadata | Documentation

Interface ClientMetadata

interface ClientMetadata {
    domain?: string;
    name?: string;
    providerMetadata: ProviderMetadata;
    version?: string;
}

Hierarchy (view full)

Properties

domain? +ClientMetadata | Documentation

Interface ClientMetadata

interface ClientMetadata {
    domain?: string;
    name?: string;
    providerMetadata: ProviderMetadata;
    version?: string;
}

Hierarchy (view full)

Properties

domain? name? providerMetadata version? -

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

-

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

+

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.CommonProvider.html b/interfaces/_openfeature_server_sdk.CommonProvider.html index 9e16ba81c..d0e31e280 100644 --- a/interfaces/_openfeature_server_sdk.CommonProvider.html +++ b/interfaces/_openfeature_server_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

Interface CommonProvider

interface CommonProvider {
    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
    metadata: ProviderMetadata;
    runsOn?: Paradigm;
    status?: ProviderStatus;
    initialize?(context?): Promise<void>;
    onClose?(): Promise<void>;
}

Hierarchy (view full)

Properties

events? +CommonProvider | Documentation

Interface CommonProvider

interface CommonProvider {
    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
    metadata: ProviderMetadata;
    runsOn?: Paradigm;
    status?: ProviderStatus;
    initialize?(context?): Promise<void>;
    onClose?(): Promise<void>;
}

Hierarchy (view full)

Properties

events? metadata runsOn? status? @@ -6,18 +6,18 @@ onClose?

Properties

Optional events

events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

Represents where the provider is intended to be run. If defined, +

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

-

Optional Readonly status

status?: ProviderStatus

Returns a representation of the current readiness of the provider. +

Optional Readonly status

status?: ProviderStatus

Returns a representation of the current readiness of the provider. If the provider needs to be initialized, it should return ProviderStatus.READY. If the provider is in an error state, it should return ProviderStatus.ERROR. If the provider is functioning normally, it should return ProviderStatus.NOT_READY.

Providers which do not implement this method are assumed to be ready immediately.

-

Methods

Optional initialize

Methods

Optional initialize

  • initialize(context?): Promise<void>

  • A function used to setup the provider. Called by the SDK after the provider is set if the provider's status is ProviderStatus.NOT_READY. When the returned promise resolves, the SDK fires the ProviderEvents.Ready event. If the returned promise rejects, the SDK fires the ProviderEvents.Error event. Use this function to perform any context-dependent setup within the provider.

    -

    Parameters

    Returns Promise<void>

Optional onClose

Optional onClose

  • onClose(): Promise<void>

  • A function used to shut down the provider. Called when this provider is replaced with a new one, or when the OpenFeature is shut down.

    -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html index f3c40c5c5..079859875 100644 --- a/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html +++ b/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html @@ -1,4 +1,4 @@ -EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

interface EvaluationLifeCycle<T> {
    addHooks(...hooks): T;
    clearHooks(): T;
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
}

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

addHooks +EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

interface EvaluationLifeCycle<T> {
    addHooks(...hooks): T;
    clearHooks(): T;
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
}

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

addHooks clearHooks getHooks

Methods

addHooks

  • addHooks(...hooks): T

  • Adds hooks that will run during flag evaluations on this receiver. @@ -8,8 +8,8 @@ Hooks registered on the client run with all evaluations on that client.

    Parameters

    • Rest ...hooks: BaseHook<FlagValue, unknown, unknown>[]

      A list of hooks that should always run

    Returns T

    The receiver (this object)

    -

clearHooks

clearHooks

getHooks

getHooks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Eventing.html b/interfaces/_openfeature_server_sdk.Eventing.html index 5d36c6134..80f553575 100644 --- a/interfaces/_openfeature_server_sdk.Eventing.html +++ b/interfaces/_openfeature_server_sdk.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation

Interface Eventing

interface Eventing {
    addHandler(eventType, handler): void;
    getHandlers(eventType): EventHandler[];
    removeHandler(eventType, handler): void;
}

Hierarchy (view full)

Implemented by

Methods

addHandler +Eventing | Documentation

Interface Eventing

interface Eventing {
    addHandler(eventType, handler): void;
    getHandlers(eventType): EventHandler[];
    removeHandler(eventType, handler): void;
}

Hierarchy (view full)

Implemented by

Methods

addHandler getHandlers removeHandler

Methods

addHandler

  • addHandler(eventType, handler): void

  • Adds a handler for the given provider event type. The handlers are called in the order they have been added.

    Parameters

    Returns void

getHandlers

  • getHandlers(eventType): EventHandler[]

  • Gets the current handlers for the given provider event type.

    +

Returns void

getHandlers

removeHandler

removeHandler

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Features.html b/interfaces/_openfeature_server_sdk.Features.html index 7a5010a99..89fdb9636 100644 --- a/interfaces/_openfeature_server_sdk.Features.html +++ b/interfaces/_openfeature_server_sdk.Features.html @@ -1,4 +1,4 @@ -Features | Documentation

Interface Features

interface Features {
    getBooleanDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<boolean>>;
    getBooleanValue(flagKey, defaultValue, context?, options?): Promise<boolean>;
    getNumberDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<number>>;
    getNumberDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getNumberValue(flagKey, defaultValue, context?, options?): Promise<number>;
    getNumberValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getObjectDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<JsonValue>>;
    getObjectDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getObjectValue(flagKey, defaultValue, context?, options?): Promise<JsonValue>;
    getObjectValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getStringDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<string>>;
    getStringDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getStringValue(flagKey, defaultValue, context?, options?): Promise<string>;
    getStringValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
}

Hierarchy (view full)

Methods

getBooleanDetails +Features | Documentation

Interface Features

interface Features {
    getBooleanDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<boolean>>;
    getBooleanValue(flagKey, defaultValue, context?, options?): Promise<boolean>;
    getNumberDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<number>>;
    getNumberDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getNumberValue(flagKey, defaultValue, context?, options?): Promise<number>;
    getNumberValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getObjectDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<JsonValue>>;
    getObjectDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getObjectValue(flagKey, defaultValue, context?, options?): Promise<JsonValue>;
    getObjectValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
    getStringDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<string>>;
    getStringDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>;
    getStringValue(flagKey, defaultValue, context?, options?): Promise<string>;
    getStringValue<T>(flagKey, defaultValue, context?, options?): Promise<T>;
}

Hierarchy (view full)

Methods

getBooleanDetails getBooleanValue getNumberDetails getNumberValue @@ -12,46 +12,46 @@
  • Optional context: EvaluationContext

    The evaluation context used on an individual flag evaluation

  • Optional options: FlagEvaluationOptions

    Additional flag evaluation options

    • Returns Promise<EvaluationDetails<boolean>>

    Flag evaluation details response

    -

    getBooleanValue

    getBooleanValue

    • getBooleanValue(flagKey, defaultValue, context?, options?): Promise<boolean>

    • Performs a flag evaluation that returns a boolean.

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

      • defaultValue: boolean

        The value returned if an error occurs

      • Optional context: EvaluationContext

        The evaluation context used on an individual flag evaluation

      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns Promise<boolean>

      Flag evaluation response

      -

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • getStringValue<T>(flagKey, defaultValue, context?, options?): Promise<T>

  • Type Parameters

    • T extends string = string

    Parameters

    Returns Promise<T>

    • Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html index 11e3368ca..f1043f397 100644 --- a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html +++ b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html @@ -1,3 +1,3 @@ -FlagEvaluationOptions | Documentation

    Interface FlagEvaluationOptions

    interface FlagEvaluationOptions {
        hookHints?: Readonly<Record<string, unknown>>;
        hooks?: Hook[];
    }

    Properties

    hookHints? +FlagEvaluationOptions | Documentation

    Interface FlagEvaluationOptions

    interface FlagEvaluationOptions {
        hookHints?: Readonly<Record<string, unknown>>;
        hooks?: Hook[];
    }

    Properties

    hookHints? hooks? -

    Properties

    Optional hookHints

    hookHints?: Readonly<Record<string, unknown>>

    Optional hooks

    hooks?: Hook[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional hookHints

    hookHints?: Readonly<Record<string, unknown>>

    Optional hooks

    hooks?: Hook[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.HookContext.html b/interfaces/_openfeature_server_sdk.HookContext.html index c3f0883eb..737ddc130 100644 --- a/interfaces/_openfeature_server_sdk.HookContext.html +++ b/interfaces/_openfeature_server_sdk.HookContext.html @@ -1,8 +1,8 @@ -HookContext | Documentation

    Interface HookContext<T>

    interface HookContext<T> {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata +HookContext | Documentation

    Interface HookContext<T>

    interface HookContext<T> {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Logger.html b/interfaces/_openfeature_server_sdk.Logger.html index 527e27141..11fc610b1 100644 --- a/interfaces/_openfeature_server_sdk.Logger.html +++ b/interfaces/_openfeature_server_sdk.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation

    Interface Logger

    interface Logger {
        debug(...args): void;
        error(...args): void;
        info(...args): void;
        warn(...args): void;
    }

    Implemented by

    Methods

    debug +Logger | Documentation

    Interface Logger

    interface Logger {
        debug(...args): void;
        error(...args): void;
        info(...args): void;
        warn(...args): void;
    }

    Implemented by

    Methods

    debug error info warn -

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageContext.html b/interfaces/_openfeature_server_sdk.ManageContext.html index d579d3c68..b422612c2 100644 --- a/interfaces/_openfeature_server_sdk.ManageContext.html +++ b/interfaces/_openfeature_server_sdk.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation

    Interface ManageContext<T>

    interface ManageContext<T> {
        getContext(): EvaluationContext;
        setContext(context): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getContext +ManageContext | Documentation

    Interface ManageContext<T>

    interface ManageContext<T> {
        getContext(): EvaluationContext;
        setContext(context): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getContext setContext

    Methods

    getContext

    setContext

    setContext

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageLogger.html b/interfaces/_openfeature_server_sdk.ManageLogger.html index a4a6e2e0e..2c2c9da3e 100644 --- a/interfaces/_openfeature_server_sdk.ManageLogger.html +++ b/interfaces/_openfeature_server_sdk.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation

    Interface ManageLogger<T>

    interface ManageLogger<T> {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation

    Interface ManageLogger<T>

    interface ManageLogger<T> {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger

    Methods

    setLogger

    • setLogger(logger): T

    • 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.

      Parameters

      • logger: Logger

        The logger to be used

      Returns T

      The receiver (this object)

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html b/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html index 2f08db145..2a535f3cb 100644 --- a/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html +++ b/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html @@ -1,4 +1,4 @@ -ManageTransactionContextPropagator | Documentation

    Interface ManageTransactionContextPropagator<T>

    interface ManageTransactionContextPropagator<T> {
        getTransactionContext(): EvaluationContext;
        setTransactionContext<R>(transactionContext, callback, ...args): void;
        setTransactionContextPropagator(transactionContextPropagator): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext +ManageTransactionContextPropagator | Documentation

    Interface ManageTransactionContextPropagator<T>

    interface ManageTransactionContextPropagator<T> {
        getTransactionContext(): EvaluationContext;
        setTransactionContext<R>(transactionContext, callback, ...args): void;
        setTransactionContextPropagator(transactionContextPropagator): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext setTransactionContext setTransactionContextPropagator

    Methods

    getTransactionContext

    setTransactionContext

    setTransactionContext

    • setTransactionContext<R>(transactionContext, callback, ...args): void
    • Experimental

      EXPERIMENTAL: Transaction context propagation is experimental and subject to change. The OpenFeature Enhancement Proposal regarding transaction context can be found here.

      Sets the transaction context using the registered transaction context propagator.

      Type Parameters

      • R

        The return value of the callback

      Parameters

      • transactionContext: EvaluationContext

        The transaction specific context

      • callback: ((...args) => R)

        Callback function used to set the transaction context on the stack

          • (...args): R

          • Parameters

            • Rest ...args: unknown[]

            Returns R

      • Rest ...args: unknown[]

        Optional arguments that are passed to the callback function

        -

      Returns void

    setTransactionContextPropagator

    • setTransactionContextPropagator(transactionContextPropagator): T
    • Experimental

      EXPERIMENTAL: Transaction context propagation is experimental and subject to change. +

    Returns void

    setTransactionContextPropagator

    • setTransactionContextPropagator(transactionContextPropagator): T
    • Experimental

      EXPERIMENTAL: Transaction context propagation is experimental and subject to change. The OpenFeature Enhancement Proposal regarding transaction context can be found here.

      Sets a transaction context propagator on this receiver. The transaction context propagator is responsible for persisting context for the duration of a single transaction.

      Parameters

      Returns T

      The receiver (this object)

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Metadata.html b/interfaces/_openfeature_server_sdk.Metadata.html index 7dc4829d2..1330d85fe 100644 --- a/interfaces/_openfeature_server_sdk.Metadata.html +++ b/interfaces/_openfeature_server_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Provider.html b/interfaces/_openfeature_server_sdk.Provider.html index 76d5a83b5..ecf6ead92 100644 --- a/interfaces/_openfeature_server_sdk.Provider.html +++ b/interfaces/_openfeature_server_sdk.Provider.html @@ -1,7 +1,7 @@ Provider | Documentation

    Interface Provider

    Interface that providers must implement to resolve flag values for their particular backend or vendor.

    Implementation for resolving all the required flag types must be defined.

    -
    interface Provider {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        hooks?: Hook[];
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: ProviderStatus;
        initialize?(context?): Promise<void>;
        onClose?(): Promise<void>;
        resolveBooleanEvaluation(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<boolean>>;
        resolveNumberEvaluation(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<number>>;
        resolveObjectEvaluation<T>(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<T>>;
        resolveStringEvaluation(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<string>>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    events? +
    interface Provider {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        hooks?: Hook[];
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: ProviderStatus;
        initialize?(context?): Promise<void>;
        onClose?(): Promise<void>;
        resolveBooleanEvaluation(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<boolean>>;
        resolveNumberEvaluation(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<number>>;
        resolveObjectEvaluation<T>(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<T>>;
        resolveStringEvaluation(flagKey, defaultValue, context, logger): Promise<ResolutionDetails<string>>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    events? hooks? metadata runsOn? @@ -14,26 +14,26 @@ resolveStringEvaluation

    Properties

    Optional events

    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Optional Readonly hooks

    hooks?: Hook[]

    A provider hook exposes a mechanism for provider authors to register hooks +

    Optional Readonly hooks

    hooks?: Hook[]

    A provider hook exposes a mechanism for provider authors to register hooks to tap into various stages of the flag evaluation lifecycle. These hooks can be used to perform side effects and mutate the context for purposes of the provider. Provider hooks are not configured or controlled by the application author.

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

    Represents where the provider is intended to be run. If defined, +

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

    Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

    -

    Optional Readonly status

    status?: ProviderStatus

    Returns a representation of the current readiness of the provider. +

    Optional Readonly status

    status?: ProviderStatus

    Returns a representation of the current readiness of the provider. If the provider needs to be initialized, it should return ProviderStatus.READY. If the provider is in an error state, it should return ProviderStatus.ERROR. If the provider is functioning normally, it should return ProviderStatus.NOT_READY.

    Providers which do not implement this method are assumed to be ready immediately.

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

    • A function used to setup the provider. Called by the SDK after the provider is set if the provider's status is ProviderStatus.NOT_READY. When the returned promise resolves, the SDK fires the ProviderEvents.Ready event. If the returned promise rejects, the SDK fires the ProviderEvents.Error event. Use this function to perform any context-dependent setup within the provider.

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html b/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html index f2e3ce58b..76e5f2d58 100644 --- a/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html +++ b/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html @@ -1,16 +1,16 @@ ProviderEventEmitter | Documentation

    Interface ProviderEventEmitter<E, AdditionalContext>

    Event emitter to be optionally implemented by providers. Implemented by

    See

    OpenFeatureEventEmitter.

    -
    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType, handler): void;
        emit(eventType, context?): void;
        getHandlers(eventType): EventHandler[];
        removeAllHandlers(eventType?): void;
        removeHandler(eventType, handler): void;
        setLogger(logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

    • E extends AnyProviderEvent

    • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +
    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType, handler): void;
        emit(eventType, context?): void;
        getHandlers(eventType): EventHandler[];
        removeAllHandlers(eventType?): void;
        removeHandler(eventType, handler): void;
        setLogger(logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

    • E extends AnyProviderEvent

    • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler emit getHandlers removeAllHandlers removeHandler setLogger -

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ProviderMetadata.html b/interfaces/_openfeature_server_sdk.ProviderMetadata.html index 140adbc75..6e83817df 100644 --- a/interfaces/_openfeature_server_sdk.ProviderMetadata.html +++ b/interfaces/_openfeature_server_sdk.ProviderMetadata.html @@ -1,3 +1,3 @@ ProviderMetadata | Documentation

    Interface ProviderMetadata

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html b/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html index 9fcd569e9..5d7b29f00 100644 --- a/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html +++ b/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html @@ -1,15 +1,15 @@ -TransactionContextPropagator | Documentation

    Interface TransactionContextPropagator

    interface TransactionContextPropagator {
        getTransactionContext(): EvaluationContext;
        setTransactionContext<R>(transactionContext, callback, ...args): void;
    }

    Hierarchy (view full)

    Methods

    getTransactionContext +TransactionContextPropagator | Documentation

    Interface TransactionContextPropagator

    interface TransactionContextPropagator {
        getTransactionContext(): EvaluationContext;
        setTransactionContext<R>(transactionContext, callback, ...args): void;
    }

    Hierarchy (view full)

    Methods

    getTransactionContext setTransactionContext

    Methods

    getTransactionContext

    setTransactionContext

    setTransactionContext

    • setTransactionContext<R>(transactionContext, callback, ...args): void
    • Experimental

      EXPERIMENTAL: Transaction context propagation is experimental and subject to change. The OpenFeature Enhancement Proposal regarding transaction context can be found here.

      Sets the transaction context using the registered transaction context propagator.

      Type Parameters

      • R

        The return value of the callback

      Parameters

      • transactionContext: EvaluationContext

        The transaction specific context

      • callback: ((...args) => R)

        Callback function used to set the transaction context on the stack

          • (...args): R

          • Parameters

            • Rest ...args: unknown[]

            Returns R

      • Rest ...args: unknown[]

        Optional arguments that are passed to the callback function

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.BaseHook.html b/interfaces/_openfeature_web_sdk.BaseHook.html index c5a431811..bdbf8f109 100644 --- a/interfaces/_openfeature_web_sdk.BaseHook.html +++ b/interfaces/_openfeature_web_sdk.BaseHook.html @@ -1,11 +1,11 @@ -BaseHook | Documentation

    Interface BaseHook<T, BeforeHookReturn, HooksReturn>

    interface BaseHook<T, BeforeHookReturn, HooksReturn> {
        after?(hookContext, evaluationDetails, hookHints?): HooksReturn;
        before?(hookContext, hookHints?): BeforeHookReturn;
        error?(hookContext, error, hookHints?): HooksReturn;
        finally?(hookContext, hookHints?): HooksReturn;
    }

    Type Parameters

    Methods

    after? +BaseHook | Documentation

    Interface BaseHook<T, BeforeHookReturn, HooksReturn>

    interface BaseHook<T, BeforeHookReturn, HooksReturn> {
        after?(hookContext, evaluationDetails, hookHints?): HooksReturn;
        before?(hookContext, hookHints?): BeforeHookReturn;
        error?(hookContext, error, hookHints?): HooksReturn;
        finally?(hookContext, hookHints?): HooksReturn;
    }

    Type Parameters

    Methods

    after? before? error? finally?

    Methods

    Optional after

    Optional before

    Optional before

    Optional error

    Optional finally

    Optional error

    Optional finally

    • finally(hookContext, hookHints?): HooksReturn

    • Runs after all other hook stages, regardless of success or error. Errors thrown here are unhandled by the client and will surface in application code.

      -

      Parameters

      • hookContext: Readonly<HookContext<T>>
      • Optional hookHints: Readonly<Record<string, unknown>>

      Returns HooksReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • hookContext: Readonly<HookContext<T>>
    • Optional hookHints: Readonly<Record<string, unknown>>

    Returns HooksReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.BeforeHookContext.html b/interfaces/_openfeature_web_sdk.BeforeHookContext.html index 8c752deae..421c87084 100644 --- a/interfaces/_openfeature_web_sdk.BeforeHookContext.html +++ b/interfaces/_openfeature_web_sdk.BeforeHookContext.html @@ -1,8 +1,8 @@ -BeforeHookContext | Documentation

    Interface BeforeHookContext

    interface BeforeHookContext {
        clientMetadata: ClientMetadata;
        context: EvaluationContext;
        defaultValue: FlagValue;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Hierarchy (view full)

    Properties

    clientMetadata +BeforeHookContext | Documentation

    Interface BeforeHookContext

    interface BeforeHookContext {
        clientMetadata: ClientMetadata;
        context: EvaluationContext;
        defaultValue: FlagValue;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Hierarchy (view full)

    Properties

    clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    context

    context: EvaluationContext

    Readonly defaultValue

    defaultValue: FlagValue

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    context

    context: EvaluationContext

    Readonly defaultValue

    defaultValue: FlagValue

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Client.html b/interfaces/_openfeature_web_sdk.Client.html index e081992ef..205a0b5b9 100644 --- a/interfaces/_openfeature_web_sdk.Client.html +++ b/interfaces/_openfeature_web_sdk.Client.html @@ -1,4 +1,4 @@ -Client | Documentation

    Interface Client

    interface Client {
        metadata: ClientMetadata;
        providerStatus: ProviderStatus;
        addHandler(eventType, handler): void;
        addHooks(...hooks): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>;
        getBooleanValue(flagKey, defaultValue, options?): boolean;
        getHandlers(eventType): EventHandler[];
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
        getNumberDetails(flagKey, defaultValue, options?): EvaluationDetails<number>;
        getNumberDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getNumberValue(flagKey, defaultValue, options?): number;
        getNumberValue<T>(flagKey, defaultValue, options?): T;
        getObjectDetails(flagKey, defaultValue, options?): EvaluationDetails<JsonValue>;
        getObjectDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getObjectValue(flagKey, defaultValue, options?): JsonValue;
        getObjectValue<T>(flagKey, defaultValue, options?): T;
        getStringDetails(flagKey, defaultValue, options?): EvaluationDetails<string>;
        getStringDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getStringValue(flagKey, defaultValue, options?): string;
        getStringValue<T>(flagKey, defaultValue, options?): T;
        removeHandler(eventType, handler): void;
        setLogger(logger): Client;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    metadata +Client | Documentation

    Interface Client

    interface Client {
        metadata: ClientMetadata;
        providerStatus: ProviderStatus;
        addHandler(eventType, handler): void;
        addHooks(...hooks): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>;
        getBooleanValue(flagKey, defaultValue, options?): boolean;
        getHandlers(eventType): EventHandler[];
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
        getNumberDetails(flagKey, defaultValue, options?): EvaluationDetails<number>;
        getNumberDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getNumberValue(flagKey, defaultValue, options?): number;
        getNumberValue<T>(flagKey, defaultValue, options?): T;
        getObjectDetails(flagKey, defaultValue, options?): EvaluationDetails<JsonValue>;
        getObjectDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getObjectValue(flagKey, defaultValue, options?): JsonValue;
        getObjectValue<T>(flagKey, defaultValue, options?): T;
        getStringDetails(flagKey, defaultValue, options?): EvaluationDetails<string>;
        getStringDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getStringValue(flagKey, defaultValue, options?): string;
        getStringValue<T>(flagKey, defaultValue, options?): T;
        removeHandler(eventType, handler): void;
        setLogger(logger): Client;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    metadata providerStatus

    Methods

    addHandler addHooks @@ -15,72 +15,72 @@ getStringValue removeHandler setLogger -

    Properties

    Readonly metadata

    metadata: ClientMetadata

    Readonly providerStatus

    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    -

    Methods

    addHandler

    • addHandler(eventType, handler): void

    • Adds a handler for the given provider event type. +

    Properties

    Readonly metadata

    metadata: ClientMetadata

    Readonly providerStatus

    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    +

    Methods

    addHandler

    addHooks

    • addHooks(...hooks): Client

    • Adds hooks that will run during flag evaluations on this receiver. +

    Returns void

    addHooks

    • addHooks(...hooks): Client

    • 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.

      Parameters

      • Rest ...hooks: BaseHook<FlagValue, unknown, unknown>[]

        A list of hooks that should always run

      Returns Client

      The receiver (this object)

      -

    clearHooks

    clearHooks

    getBooleanDetails

    getBooleanDetails

    getBooleanValue

    getBooleanValue

    • getBooleanValue(flagKey, defaultValue, options?): boolean

    • Performs a flag evaluation that returns a boolean.

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

      • defaultValue: boolean

        The value returned if an error occurs

      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns boolean

      Flag evaluation response

      -

    getHandlers

    getHandlers

    getHooks

    getHooks

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    removeHandler

    removeHandler

    setLogger

    • setLogger(logger): Client

    • Sets a logger on this receiver. This logger supersedes to the global logger +

    Returns void

    setLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ClientMetadata.html b/interfaces/_openfeature_web_sdk.ClientMetadata.html index de28703d8..dd7c8e549 100644 --- a/interfaces/_openfeature_web_sdk.ClientMetadata.html +++ b/interfaces/_openfeature_web_sdk.ClientMetadata.html @@ -1,6 +1,6 @@ -ClientMetadata | Documentation

    Interface ClientMetadata

    interface ClientMetadata {
        domain?: string;
        name?: string;
        providerMetadata: ProviderMetadata;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    domain? +ClientMetadata | Documentation

    Interface ClientMetadata

    interface ClientMetadata {
        domain?: string;
        name?: string;
        providerMetadata: ProviderMetadata;
        version?: string;
    }

    Hierarchy (view full)

    Properties

    domain? name? providerMetadata version? -

    Properties

    Optional Readonly domain

    domain?: string

    Optional Readonly name

    name?: string

    Deprecated

    alias of "domain", use domain instead

    -

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Optional Readonly version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly domain

    domain?: string

    Optional Readonly name

    name?: string

    Deprecated

    alias of "domain", use domain instead

    +

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Optional Readonly version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.CommonProvider.html b/interfaces/_openfeature_web_sdk.CommonProvider.html index b0bfef019..93aa0928e 100644 --- a/interfaces/_openfeature_web_sdk.CommonProvider.html +++ b/interfaces/_openfeature_web_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

    Interface CommonProvider

    interface CommonProvider {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: ProviderStatus;
        initialize?(context?): Promise<void>;
        onClose?(): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    events? +CommonProvider | Documentation

    Interface CommonProvider

    interface CommonProvider {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: ProviderStatus;
        initialize?(context?): Promise<void>;
        onClose?(): Promise<void>;
    }

    Hierarchy (view full)

    Properties

    events? metadata runsOn? status? @@ -6,18 +6,18 @@ onClose?

    Properties

    Optional events

    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

    Represents where the provider is intended to be run. If defined, +

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

    Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

    -

    Optional Readonly status

    status?: ProviderStatus

    Returns a representation of the current readiness of the provider. +

    Optional Readonly status

    status?: ProviderStatus

    Returns a representation of the current readiness of the provider. If the provider needs to be initialized, it should return ProviderStatus.READY. If the provider is in an error state, it should return ProviderStatus.ERROR. If the provider is functioning normally, it should return ProviderStatus.NOT_READY.

    Providers which do not implement this method are assumed to be ready immediately.

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

    • A function used to setup the provider. Called by the SDK after the provider is set if the provider's status is ProviderStatus.NOT_READY. When the returned promise resolves, the SDK fires the ProviderEvents.Ready event. If the returned promise rejects, the SDK fires the ProviderEvents.Error event. Use this function to perform any context-dependent setup within the provider.

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    • onClose(): Promise<void>

    • A function used to shut down the provider. Called when this provider is replaced with a new one, or when the OpenFeature is shut down.

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html index 2ffa790ec..720039eb0 100644 --- a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html +++ b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html @@ -1,4 +1,4 @@ -EvaluationLifeCycle | Documentation

    Interface EvaluationLifeCycle<T>

    interface EvaluationLifeCycle<T> {
        addHooks(...hooks): T;
        clearHooks(): T;
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    addHooks +EvaluationLifeCycle | Documentation

    Interface EvaluationLifeCycle<T>

    interface EvaluationLifeCycle<T> {
        addHooks(...hooks): T;
        clearHooks(): T;
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    addHooks clearHooks getHooks

    Methods

    addHooks

    • addHooks(...hooks): T

    • Adds hooks that will run during flag evaluations on this receiver. @@ -8,8 +8,8 @@ Hooks registered on the client run with all evaluations on that client.

      Parameters

      • Rest ...hooks: BaseHook<FlagValue, unknown, unknown>[]

        A list of hooks that should always run

      Returns T

      The receiver (this object)

      -

    clearHooks

    clearHooks

    getHooks

    getHooks

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Eventing.html b/interfaces/_openfeature_web_sdk.Eventing.html index b6591fd0a..81659d145 100644 --- a/interfaces/_openfeature_web_sdk.Eventing.html +++ b/interfaces/_openfeature_web_sdk.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation

    Interface Eventing

    interface Eventing {
        addHandler(eventType, handler): void;
        getHandlers(eventType): EventHandler[];
        removeHandler(eventType, handler): void;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +Eventing | Documentation

    Interface Eventing

    interface Eventing {
        addHandler(eventType, handler): void;
        getHandlers(eventType): EventHandler[];
        removeHandler(eventType, handler): void;
    }

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler getHandlers removeHandler

    Methods

    addHandler

    • addHandler(eventType, handler): void

    • Adds a handler for the given provider event type. The handlers are called in the order they have been added.

      Parameters

      Returns void

    getHandlers

    • getHandlers(eventType): EventHandler[]

    • Gets the current handlers for the given provider event type.

      +

    Returns void

    getHandlers

    removeHandler

    removeHandler

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Features.html b/interfaces/_openfeature_web_sdk.Features.html index f4da08c2d..9a00610d1 100644 --- a/interfaces/_openfeature_web_sdk.Features.html +++ b/interfaces/_openfeature_web_sdk.Features.html @@ -1,4 +1,4 @@ -Features | Documentation

    Interface Features

    interface Features {
        getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>;
        getBooleanValue(flagKey, defaultValue, options?): boolean;
        getNumberDetails(flagKey, defaultValue, options?): EvaluationDetails<number>;
        getNumberDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getNumberValue(flagKey, defaultValue, options?): number;
        getNumberValue<T>(flagKey, defaultValue, options?): T;
        getObjectDetails(flagKey, defaultValue, options?): EvaluationDetails<JsonValue>;
        getObjectDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getObjectValue(flagKey, defaultValue, options?): JsonValue;
        getObjectValue<T>(flagKey, defaultValue, options?): T;
        getStringDetails(flagKey, defaultValue, options?): EvaluationDetails<string>;
        getStringDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getStringValue(flagKey, defaultValue, options?): string;
        getStringValue<T>(flagKey, defaultValue, options?): T;
    }

    Hierarchy (view full)

    Methods

    getBooleanDetails +Features | Documentation

    Interface Features

    interface Features {
        getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>;
        getBooleanValue(flagKey, defaultValue, options?): boolean;
        getNumberDetails(flagKey, defaultValue, options?): EvaluationDetails<number>;
        getNumberDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getNumberValue(flagKey, defaultValue, options?): number;
        getNumberValue<T>(flagKey, defaultValue, options?): T;
        getObjectDetails(flagKey, defaultValue, options?): EvaluationDetails<JsonValue>;
        getObjectDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getObjectValue(flagKey, defaultValue, options?): JsonValue;
        getObjectValue<T>(flagKey, defaultValue, options?): T;
        getStringDetails(flagKey, defaultValue, options?): EvaluationDetails<string>;
        getStringDetails<T>(flagKey, defaultValue, options?): EvaluationDetails<T>;
        getStringValue(flagKey, defaultValue, options?): string;
        getStringValue<T>(flagKey, defaultValue, options?): T;
    }

    Hierarchy (view full)

    Methods

    getBooleanDetails getBooleanValue getNumberDetails getNumberValue @@ -11,39 +11,39 @@
  • defaultValue: boolean

    The value returned if an error occurs

  • Optional options: FlagEvaluationOptions

    Additional flag evaluation options

    • Returns EvaluationDetails<boolean>

    Flag evaluation details response

    -

    getBooleanValue

    getBooleanValue

    • getBooleanValue(flagKey, defaultValue, options?): boolean

    • Performs a flag evaluation that returns a boolean.

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

      • defaultValue: boolean

        The value returned if an error occurs

      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns boolean

      Flag evaluation response

      -

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
  • getStringValue<T>(flagKey, defaultValue, options?): T

  • Type Parameters

    • T extends string = string

    Parameters

    Returns T

    • Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html index ab7e039e8..f3b6b3c6e 100644 --- a/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html +++ b/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html @@ -1,3 +1,3 @@ -FlagEvaluationOptions | Documentation

    Interface FlagEvaluationOptions

    interface FlagEvaluationOptions {
        hookHints?: Readonly<Record<string, unknown>>;
        hooks?: BaseHook<FlagValue, unknown, unknown>[];
    }

    Properties

    hookHints? +FlagEvaluationOptions | Documentation

    Interface FlagEvaluationOptions

    interface FlagEvaluationOptions {
        hookHints?: Readonly<Record<string, unknown>>;
        hooks?: BaseHook<FlagValue, unknown, unknown>[];
    }

    Properties

    hookHints? hooks? -

    Properties

    Optional hookHints

    hookHints?: Readonly<Record<string, unknown>>

    Optional hooks

    hooks?: BaseHook<FlagValue, unknown, unknown>[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional hookHints

    hookHints?: Readonly<Record<string, unknown>>

    Optional hooks

    hooks?: BaseHook<FlagValue, unknown, unknown>[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.HookContext.html b/interfaces/_openfeature_web_sdk.HookContext.html index 4d85c3385..6af7b9dc7 100644 --- a/interfaces/_openfeature_web_sdk.HookContext.html +++ b/interfaces/_openfeature_web_sdk.HookContext.html @@ -1,8 +1,8 @@ -HookContext | Documentation

    Interface HookContext<T>

    interface HookContext<T> {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata +HookContext | Documentation

    Interface HookContext<T>

    interface HookContext<T> {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Logger.html b/interfaces/_openfeature_web_sdk.Logger.html index 1f6319c72..6c6645efd 100644 --- a/interfaces/_openfeature_web_sdk.Logger.html +++ b/interfaces/_openfeature_web_sdk.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation

    Interface Logger

    interface Logger {
        debug(...args): void;
        error(...args): void;
        info(...args): void;
        warn(...args): void;
    }

    Implemented by

    Methods

    debug +Logger | Documentation

    Interface Logger

    interface Logger {
        debug(...args): void;
        error(...args): void;
        info(...args): void;
        warn(...args): void;
    }

    Implemented by

    Methods

    debug error info warn -

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ManageContext.html b/interfaces/_openfeature_web_sdk.ManageContext.html index e9489d1aa..09db96544 100644 --- a/interfaces/_openfeature_web_sdk.ManageContext.html +++ b/interfaces/_openfeature_web_sdk.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation

    Interface ManageContext<T>

    interface ManageContext<T> {
        getContext(): EvaluationContext;
        setContext(context): T;
    }

    Type Parameters

    • T

    Implemented by

    Methods

    getContext +ManageContext | Documentation

    Interface ManageContext<T>

    interface ManageContext<T> {
        getContext(): EvaluationContext;
        setContext(context): T;
    }

    Type Parameters

    • T

    Implemented by

    Methods

    getContext setContext

    Methods

    getContext

    setContext

    setContext

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ManageLogger.html b/interfaces/_openfeature_web_sdk.ManageLogger.html index 836441ab2..b159cc5c6 100644 --- a/interfaces/_openfeature_web_sdk.ManageLogger.html +++ b/interfaces/_openfeature_web_sdk.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation

    Interface ManageLogger<T>

    interface ManageLogger<T> {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation

    Interface ManageLogger<T>

    interface ManageLogger<T> {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger

    Methods

    setLogger

    • setLogger(logger): T

    • 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.

      Parameters

      • logger: Logger

        The logger to be used

      Returns T

      The receiver (this object)

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Metadata.html b/interfaces/_openfeature_web_sdk.Metadata.html index 6281e9c2b..f88a7acb5 100644 --- a/interfaces/_openfeature_web_sdk.Metadata.html +++ b/interfaces/_openfeature_web_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Provider.html b/interfaces/_openfeature_web_sdk.Provider.html index 8caa2f330..391732bcf 100644 --- a/interfaces/_openfeature_web_sdk.Provider.html +++ b/interfaces/_openfeature_web_sdk.Provider.html @@ -1,7 +1,7 @@ Provider | Documentation

    Interface Provider

    Interface that providers must implement to resolve flag values for their particular backend or vendor.

    Implementation for resolving all the required flag types must be defined.

    -
    interface Provider {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        hooks?: Hook[];
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: ProviderStatus;
        initialize?(context?): Promise<void>;
        onClose?(): Promise<void>;
        onContextChange?(oldContext, newContext): Promise<void>;
        resolveBooleanEvaluation(flagKey, defaultValue, context, logger): ResolutionDetails<boolean>;
        resolveNumberEvaluation(flagKey, defaultValue, context, logger): ResolutionDetails<number>;
        resolveObjectEvaluation<T>(flagKey, defaultValue, context, logger): ResolutionDetails<T>;
        resolveStringEvaluation(flagKey, defaultValue, context, logger): ResolutionDetails<string>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    events? +
    interface Provider {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        hooks?: Hook[];
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: ProviderStatus;
        initialize?(context?): Promise<void>;
        onClose?(): Promise<void>;
        onContextChange?(oldContext, newContext): Promise<void>;
        resolveBooleanEvaluation(flagKey, defaultValue, context, logger): ResolutionDetails<boolean>;
        resolveNumberEvaluation(flagKey, defaultValue, context, logger): ResolutionDetails<number>;
        resolveObjectEvaluation<T>(flagKey, defaultValue, context, logger): ResolutionDetails<T>;
        resolveStringEvaluation(flagKey, defaultValue, context, logger): ResolutionDetails<string>;
    }

    Hierarchy (view full)

    Implemented by

    Properties

    events? hooks? metadata runsOn? @@ -15,28 +15,28 @@ resolveStringEvaluation

    Properties

    Optional events

    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Optional Readonly hooks

    hooks?: Hook[]

    A provider hook exposes a mechanism for provider authors to register hooks +

    Optional Readonly hooks

    hooks?: Hook[]

    A provider hook exposes a mechanism for provider authors to register hooks to tap into various stages of the flag evaluation lifecycle. These hooks can be used to perform side effects and mutate the context for purposes of the provider. Provider hooks are not configured or controlled by the application author.

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

    Represents where the provider is intended to be run. If defined, +

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

    Represents where the provider is intended to be run. If defined, the SDK will enforce that the defined paradigm at runtime.

    -

    Optional Readonly status

    status?: ProviderStatus

    Returns a representation of the current readiness of the provider. +

    Optional Readonly status

    status?: ProviderStatus

    Returns a representation of the current readiness of the provider. If the provider needs to be initialized, it should return ProviderStatus.READY. If the provider is in an error state, it should return ProviderStatus.ERROR. If the provider is functioning normally, it should return ProviderStatus.NOT_READY.

    Providers which do not implement this method are assumed to be ready immediately.

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

    • A function used to setup the provider. Called by the SDK after the provider is set if the provider's status is ProviderStatus.NOT_READY. When the returned promise resolves, the SDK fires the ProviderEvents.Ready event. If the returned promise rejects, the SDK fires the ProviderEvents.Error event. Use this function to perform any context-dependent setup within the provider.

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    Optional onContextChange

    Optional onContextChange

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html b/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html index be13d980f..d95e70afc 100644 --- a/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html +++ b/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html @@ -1,16 +1,16 @@ ProviderEventEmitter | Documentation

    Interface ProviderEventEmitter<E, AdditionalContext>

    Event emitter to be optionally implemented by providers. Implemented by

    See

    OpenFeatureEventEmitter.

    -
    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType, handler): void;
        emit(eventType, context?): void;
        getHandlers(eventType): EventHandler[];
        removeAllHandlers(eventType?): void;
        removeHandler(eventType, handler): void;
        setLogger(logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

    • E extends AnyProviderEvent

    • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +
    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType, handler): void;
        emit(eventType, context?): void;
        getHandlers(eventType): EventHandler[];
        removeAllHandlers(eventType?): void;
        removeHandler(eventType, handler): void;
        setLogger(logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

    • E extends AnyProviderEvent

    • AdditionalContext extends Record<string, unknown> = Record<string, unknown>

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler emit getHandlers removeAllHandlers removeHandler setLogger -

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ProviderMetadata.html b/interfaces/_openfeature_web_sdk.ProviderMetadata.html index a2d34ac16..38fb30028 100644 --- a/interfaces/_openfeature_web_sdk.ProviderMetadata.html +++ b/interfaces/_openfeature_web_sdk.ProviderMetadata.html @@ -1,3 +1,3 @@ ProviderMetadata | Documentation

    Interface ProviderMetadata

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_openfeature_server_sdk.html b/modules/_openfeature_server_sdk.html index 42f5ab551..e900f6d1e 100644 --- a/modules/_openfeature_server_sdk.html +++ b/modules/_openfeature_server_sdk.html @@ -1,4 +1,4 @@ -@openfeature/server-sdk - v1.11.0 | Documentation

    Module @openfeature/server-sdk - v1.11.0

    +@openfeature/server-sdk - v1.12.0 | Documentation

    Module @openfeature/server-sdk - v1.12.0

    @@ -16,8 +16,8 @@

    OpenFeature Node.js SDK

    Specification - - Release + + Release
    diff --git a/types/_openfeature_core.AnyProviderEvent.html b/types/_openfeature_core.AnyProviderEvent.html index 76d361986..19391bf8c 100644 --- a/types/_openfeature_core.AnyProviderEvent.html +++ b/types/_openfeature_core.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    Type alias AnyProviderEvent

    AnyProviderEvent: ServerProviderEvents | ClientProviderEvents

    A type representing any possible ProviderEvent (server or client side). If you are implementing a hook or provider, you probably want to import ProviderEvents from the respective SDK.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.CommonEventDetails.html b/types/_openfeature_core.CommonEventDetails.html index 050b1ebd5..a8e3674f0 100644 --- a/types/_openfeature_core.CommonEventDetails.html +++ b/types/_openfeature_core.CommonEventDetails.html @@ -1,2 +1,2 @@ CommonEventDetails | Documentation

    Type alias CommonEventDetails

    CommonEventDetails: {
        clientName?: string;
        domain?: string;
        providerName: string;
    }

    Type declaration

    • Optional clientName?: string

      Deprecated

      alias of "domain", use domain instead

      -
    • Optional Readonly domain?: string
    • providerName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional Readonly domain?: string
  • providerName: string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ConfigChangeEvent.html b/types/_openfeature_core.ConfigChangeEvent.html index 2d403de84..337285e45 100644 --- a/types/_openfeature_core.ConfigChangeEvent.html +++ b/types/_openfeature_core.ConfigChangeEvent.html @@ -1 +1 @@ -ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ErrorEvent.html b/types/_openfeature_core.ErrorEvent.html index a9b39a9ac..8454e2ae5 100644 --- a/types/_openfeature_core.ErrorEvent.html +++ b/types/_openfeature_core.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EvaluationContext.html b/types/_openfeature_core.EvaluationContext.html index 9f93bbec2..e787ac70d 100644 --- a/types/_openfeature_core.EvaluationContext.html +++ b/types/_openfeature_core.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EvaluationContextValue.html b/types/_openfeature_core.EvaluationContextValue.html index 55d71fc53..85a4011a0 100644 --- a/types/_openfeature_core.EvaluationContextValue.html +++ b/types/_openfeature_core.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

    EvaluationContextValue: PrimitiveValue | Date | {
        [key: string]: EvaluationContextValue;
    } | EvaluationContextValue[]

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

    EvaluationContextValue: PrimitiveValue | Date | {
        [key: string]: EvaluationContextValue;
    } | EvaluationContextValue[]

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EvaluationDetails.html b/types/_openfeature_core.EvaluationDetails.html index be82f9160..3c639f791 100644 --- a/types/_openfeature_core.EvaluationDetails.html +++ b/types/_openfeature_core.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EventContext.html b/types/_openfeature_core.EventContext.html index 7ceb00cae..19af41d9d 100644 --- a/types/_openfeature_core.EventContext.html +++ b/types/_openfeature_core.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<U>

    EventContext<U>: EventMap[ClientProviderEvents] & U

    Type Parameters

    • U extends Record<string, unknown> = Record<string, unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U>

    EventContext<U>: EventMap[ClientProviderEvents] & U

    Type Parameters

    • U extends Record<string, unknown> = Record<string, unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EventDetails.html b/types/_openfeature_core.EventDetails.html index ff49d311a..be7e4135e 100644 --- a/types/_openfeature_core.EventDetails.html +++ b/types/_openfeature_core.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation

    Type alias EventDetails

    EventDetails: EventContext & CommonEventDetails

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails

    EventDetails: EventContext & CommonEventDetails

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EventHandler.html b/types/_openfeature_core.EventHandler.html index ea6244dcf..6794f51a0 100644 --- a/types/_openfeature_core.EventHandler.html +++ b/types/_openfeature_core.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation

    Type alias EventHandler

    EventHandler: ((eventDetails?) => Promise<unknown> | unknown)

    Type declaration

      • (eventDetails?): Promise<unknown> | unknown

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler

    EventHandler: ((eventDetails?) => Promise<unknown> | unknown)

    Type declaration

      • (eventDetails?): Promise<unknown> | unknown

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EventMetadata.html b/types/_openfeature_core.EventMetadata.html index b50ede220..6cbe61a8f 100644 --- a/types/_openfeature_core.EventMetadata.html +++ b/types/_openfeature_core.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation

    Type alias EventMetadata

    EventMetadata: {
        [key: string]: string | boolean | number;
    }

    Type declaration

    • [key: string]: string | boolean | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventMetadata | Documentation

    Type alias EventMetadata

    EventMetadata: {
        [key: string]: string | boolean | number;
    }

    Type declaration

    • [key: string]: string | boolean | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.FlagMetadata.html b/types/_openfeature_core.FlagMetadata.html index ae7dcdbc0..4a534f751 100644 --- a/types/_openfeature_core.FlagMetadata.html +++ b/types/_openfeature_core.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation

    Type alias FlagMetadata

    FlagMetadata: Record<string, string | number | boolean>

    A structure which supports definition of arbitrary properties, with keys of type string, and values of type boolean, string, or number.

    This structure is populated by a provider for use by an Application Author (via the Evaluation API) or an Application Integrator (via hooks).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.FlagValue.html b/types/_openfeature_core.FlagValue.html index df9a77c9e..48159d59e 100644 --- a/types/_openfeature_core.FlagValue.html +++ b/types/_openfeature_core.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation

    Type alias FlagValue

    FlagValue: boolean | string | number | JsonValue

    Represents a JSON node value, or Date.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.FlagValueType.html b/types/_openfeature_core.FlagValueType.html index 153cea61e..3b50a22e9 100644 --- a/types/_openfeature_core.FlagValueType.html +++ b/types/_openfeature_core.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation

    Type alias FlagValueType

    FlagValueType: "boolean" | "string" | "number" | "object"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

    FlagValueType: "boolean" | "string" | "number" | "object"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.HookHints.html b/types/_openfeature_core.HookHints.html index b5a9ae8d8..6d152855a 100644 --- a/types/_openfeature_core.HookHints.html +++ b/types/_openfeature_core.HookHints.html @@ -1 +1 @@ -HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.JsonArray.html b/types/_openfeature_core.JsonArray.html index c26a1ed44..a8eb76d37 100644 --- a/types/_openfeature_core.JsonArray.html +++ b/types/_openfeature_core.JsonArray.html @@ -1 +1 @@ -JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.JsonObject.html b/types/_openfeature_core.JsonObject.html index 7ba0fda8a..925afaecb 100644 --- a/types/_openfeature_core.JsonObject.html +++ b/types/_openfeature_core.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation

    Type alias JsonObject

    JsonObject: {
        [key: string]: JsonValue;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

    JsonObject: {
        [key: string]: JsonValue;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.JsonValue.html b/types/_openfeature_core.JsonValue.html index f50bea10c..09590e452 100644 --- a/types/_openfeature_core.JsonValue.html +++ b/types/_openfeature_core.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.Paradigm.html b/types/_openfeature_core.Paradigm.html index ec8b3bf96..5d7611d69 100644 --- a/types/_openfeature_core.Paradigm.html +++ b/types/_openfeature_core.Paradigm.html @@ -1,2 +1,2 @@ Paradigm | Documentation

    Type alias Paradigm

    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.PrimitiveValue.html b/types/_openfeature_core.PrimitiveValue.html index 9047059fd..d6dcf326c 100644 --- a/types/_openfeature_core.PrimitiveValue.html +++ b/types/_openfeature_core.PrimitiveValue.html @@ -1 +1 @@ -PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ReadyEvent.html b/types/_openfeature_core.ReadyEvent.html index 66a73588d..14311d24e 100644 --- a/types/_openfeature_core.ReadyEvent.html +++ b/types/_openfeature_core.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ResolutionDetails.html b/types/_openfeature_core.ResolutionDetails.html index 7949ed4eb..86592b9e7 100644 --- a/types/_openfeature_core.ResolutionDetails.html +++ b/types/_openfeature_core.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ResolutionReason.html b/types/_openfeature_core.ResolutionReason.html index 7d8636cf9..7a5b66a2b 100644 --- a/types/_openfeature_core.ResolutionReason.html +++ b/types/_openfeature_core.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation

    Type alias ResolutionReason

    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.StaleEvent.html b/types/_openfeature_core.StaleEvent.html index 029cea2ff..0b55a2db3 100644 --- a/types/_openfeature_core.StaleEvent.html +++ b/types/_openfeature_core.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.AnyProviderEvent.html b/types/_openfeature_server_sdk.AnyProviderEvent.html index 910694a49..6514c43d4 100644 --- a/types/_openfeature_server_sdk.AnyProviderEvent.html +++ b/types/_openfeature_server_sdk.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    Type alias AnyProviderEvent

    AnyProviderEvent: ProviderEvents | ClientProviderEvents

    A type representing any possible ProviderEvent (server or client side). If you are implementing a hook or provider, you probably want to import ProviderEvents from the respective SDK.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.CommonEventDetails.html b/types/_openfeature_server_sdk.CommonEventDetails.html index eef91fb3f..140be6a06 100644 --- a/types/_openfeature_server_sdk.CommonEventDetails.html +++ b/types/_openfeature_server_sdk.CommonEventDetails.html @@ -1,2 +1,2 @@ CommonEventDetails | Documentation

    Type alias CommonEventDetails

    CommonEventDetails: {
        clientName?: string;
        domain?: string;
        providerName: string;
    }

    Type declaration

    • Optional clientName?: string

      Deprecated

      alias of "domain", use domain instead

      -
    • Optional Readonly domain?: string
    • providerName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional Readonly domain?: string
  • providerName: string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ConfigChangeEvent.html b/types/_openfeature_server_sdk.ConfigChangeEvent.html index f27c5e0fd..99b66dd99 100644 --- a/types/_openfeature_server_sdk.ConfigChangeEvent.html +++ b/types/_openfeature_server_sdk.ConfigChangeEvent.html @@ -1 +1 @@ -ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ErrorEvent.html b/types/_openfeature_server_sdk.ErrorEvent.html index f606d19f6..6ece668ff 100644 --- a/types/_openfeature_server_sdk.ErrorEvent.html +++ b/types/_openfeature_server_sdk.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationContext.html b/types/_openfeature_server_sdk.EvaluationContext.html index 219925295..836d454d2 100644 --- a/types/_openfeature_server_sdk.EvaluationContext.html +++ b/types/_openfeature_server_sdk.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationContextValue.html b/types/_openfeature_server_sdk.EvaluationContextValue.html index 714857935..42d38bba5 100644 --- a/types/_openfeature_server_sdk.EvaluationContextValue.html +++ b/types/_openfeature_server_sdk.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

    EvaluationContextValue: PrimitiveValue | Date | {
        [key: string]: EvaluationContextValue;
    } | EvaluationContextValue[]

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

    EvaluationContextValue: PrimitiveValue | Date | {
        [key: string]: EvaluationContextValue;
    } | EvaluationContextValue[]

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationDetails.html b/types/_openfeature_server_sdk.EvaluationDetails.html index d9a35dd60..9258bb19e 100644 --- a/types/_openfeature_server_sdk.EvaluationDetails.html +++ b/types/_openfeature_server_sdk.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventContext.html b/types/_openfeature_server_sdk.EventContext.html index 6a4ccc6d3..828d693c5 100644 --- a/types/_openfeature_server_sdk.EventContext.html +++ b/types/_openfeature_server_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<U>

    EventContext<U>: EventMap[ClientProviderEvents] & U

    Type Parameters

    • U extends Record<string, unknown> = Record<string, unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U>

    EventContext<U>: EventMap[ClientProviderEvents] & U

    Type Parameters

    • U extends Record<string, unknown> = Record<string, unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventDetails.html b/types/_openfeature_server_sdk.EventDetails.html index 5b4fac5e7..4b9620e54 100644 --- a/types/_openfeature_server_sdk.EventDetails.html +++ b/types/_openfeature_server_sdk.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation

    Type alias EventDetails

    EventDetails: EventContext & CommonEventDetails

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails

    EventDetails: EventContext & CommonEventDetails

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventHandler.html b/types/_openfeature_server_sdk.EventHandler.html index afebc2b87..8ad09595c 100644 --- a/types/_openfeature_server_sdk.EventHandler.html +++ b/types/_openfeature_server_sdk.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation

    Type alias EventHandler

    EventHandler: ((eventDetails?) => Promise<unknown> | unknown)

    Type declaration

      • (eventDetails?): Promise<unknown> | unknown

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler

    EventHandler: ((eventDetails?) => Promise<unknown> | unknown)

    Type declaration

      • (eventDetails?): Promise<unknown> | unknown

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventMetadata.html b/types/_openfeature_server_sdk.EventMetadata.html index 4146264c2..9a5b6e29e 100644 --- a/types/_openfeature_server_sdk.EventMetadata.html +++ b/types/_openfeature_server_sdk.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation

    Type alias EventMetadata

    EventMetadata: {
        [key: string]: string | boolean | number;
    }

    Type declaration

    • [key: string]: string | boolean | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventMetadata | Documentation

    Type alias EventMetadata

    EventMetadata: {
        [key: string]: string | boolean | number;
    }

    Type declaration

    • [key: string]: string | boolean | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagMetadata.html b/types/_openfeature_server_sdk.FlagMetadata.html index 296a91e0c..3b6d7dc91 100644 --- a/types/_openfeature_server_sdk.FlagMetadata.html +++ b/types/_openfeature_server_sdk.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation

    Type alias FlagMetadata

    FlagMetadata: Record<string, string | number | boolean>

    A structure which supports definition of arbitrary properties, with keys of type string, and values of type boolean, string, or number.

    This structure is populated by a provider for use by an Application Author (via the Evaluation API) or an Application Integrator (via hooks).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagValue.html b/types/_openfeature_server_sdk.FlagValue.html index 2540be0f8..b1039950a 100644 --- a/types/_openfeature_server_sdk.FlagValue.html +++ b/types/_openfeature_server_sdk.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation

    Type alias FlagValue

    FlagValue: boolean | string | number | JsonValue

    Represents a JSON node value, or Date.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagValueType.html b/types/_openfeature_server_sdk.FlagValueType.html index 107c1a4f5..baf4a0d50 100644 --- a/types/_openfeature_server_sdk.FlagValueType.html +++ b/types/_openfeature_server_sdk.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation

    Type alias FlagValueType

    FlagValueType: "boolean" | "string" | "number" | "object"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

    FlagValueType: "boolean" | "string" | "number" | "object"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.Hook.html b/types/_openfeature_server_sdk.Hook.html index 0ab26aa1a..3a395a4f1 100644 --- a/types/_openfeature_server_sdk.Hook.html +++ b/types/_openfeature_server_sdk.Hook.html @@ -1 +1 @@ -Hook | Documentation

    Type alias Hook

    Hook: BaseHook<FlagValue, Promise<EvaluationContext | void> | EvaluationContext | void, Promise<void> | void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Hook | Documentation

    Type alias Hook

    Hook: BaseHook<FlagValue, Promise<EvaluationContext | void> | EvaluationContext | void, Promise<void> | void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.HookHints.html b/types/_openfeature_server_sdk.HookHints.html index 097469154..025881702 100644 --- a/types/_openfeature_server_sdk.HookHints.html +++ b/types/_openfeature_server_sdk.HookHints.html @@ -1 +1 @@ -HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.JsonArray.html b/types/_openfeature_server_sdk.JsonArray.html index 5bb84652d..507188985 100644 --- a/types/_openfeature_server_sdk.JsonArray.html +++ b/types/_openfeature_server_sdk.JsonArray.html @@ -1 +1 @@ -JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.JsonObject.html b/types/_openfeature_server_sdk.JsonObject.html index 088406fa5..220447b9e 100644 --- a/types/_openfeature_server_sdk.JsonObject.html +++ b/types/_openfeature_server_sdk.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation

    Type alias JsonObject

    JsonObject: {
        [key: string]: JsonValue;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

    JsonObject: {
        [key: string]: JsonValue;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.JsonValue.html b/types/_openfeature_server_sdk.JsonValue.html index 233255881..0f72900c4 100644 --- a/types/_openfeature_server_sdk.JsonValue.html +++ b/types/_openfeature_server_sdk.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.Paradigm.html b/types/_openfeature_server_sdk.Paradigm.html index 42088f33a..f6b2e70fe 100644 --- a/types/_openfeature_server_sdk.Paradigm.html +++ b/types/_openfeature_server_sdk.Paradigm.html @@ -1,2 +1,2 @@ Paradigm | Documentation

    Type alias Paradigm

    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.PrimitiveValue.html b/types/_openfeature_server_sdk.PrimitiveValue.html index fe45e6b0f..f57aadc96 100644 --- a/types/_openfeature_server_sdk.PrimitiveValue.html +++ b/types/_openfeature_server_sdk.PrimitiveValue.html @@ -1 +1 @@ -PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ReadyEvent.html b/types/_openfeature_server_sdk.ReadyEvent.html index 8747a9163..a5781ca33 100644 --- a/types/_openfeature_server_sdk.ReadyEvent.html +++ b/types/_openfeature_server_sdk.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ResolutionDetails.html b/types/_openfeature_server_sdk.ResolutionDetails.html index a4a29c9bc..25bfef9a7 100644 --- a/types/_openfeature_server_sdk.ResolutionDetails.html +++ b/types/_openfeature_server_sdk.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ResolutionReason.html b/types/_openfeature_server_sdk.ResolutionReason.html index 19c35e805..7d977697e 100644 --- a/types/_openfeature_server_sdk.ResolutionReason.html +++ b/types/_openfeature_server_sdk.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation

    Type alias ResolutionReason

    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.StaleEvent.html b/types/_openfeature_server_sdk.StaleEvent.html index f7891064d..3c0cb583c 100644 --- a/types/_openfeature_server_sdk.StaleEvent.html +++ b/types/_openfeature_server_sdk.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.TransactionContext.html b/types/_openfeature_server_sdk.TransactionContext.html index 699d15d73..c81b1743c 100644 --- a/types/_openfeature_server_sdk.TransactionContext.html +++ b/types/_openfeature_server_sdk.TransactionContext.html @@ -1,4 +1,4 @@ TransactionContext | Documentation

    Type alias TransactionContext

    TransactionContext: EvaluationContext

    Transaction context is a mechanism for adding transaction specific context that is merged with evaluation context prior to flag evaluation. Examples of potential transaction specific context include: a user id, user agent, or request path.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.AnyProviderEvent.html b/types/_openfeature_web_sdk.AnyProviderEvent.html index d7328d02b..94ae41e05 100644 --- a/types/_openfeature_web_sdk.AnyProviderEvent.html +++ b/types/_openfeature_web_sdk.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    Type alias AnyProviderEvent

    AnyProviderEvent: ServerProviderEvents | ProviderEvents

    A type representing any possible ProviderEvent (server or client side). If you are implementing a hook or provider, you probably want to import ProviderEvents from the respective SDK.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.CommonEventDetails.html b/types/_openfeature_web_sdk.CommonEventDetails.html index 9a47f1e15..d027e3626 100644 --- a/types/_openfeature_web_sdk.CommonEventDetails.html +++ b/types/_openfeature_web_sdk.CommonEventDetails.html @@ -1,2 +1,2 @@ CommonEventDetails | Documentation

    Type alias CommonEventDetails

    CommonEventDetails: {
        clientName?: string;
        domain?: string;
        providerName: string;
    }

    Type declaration

    • Optional clientName?: string

      Deprecated

      alias of "domain", use domain instead

      -
    • Optional Readonly domain?: string
    • providerName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional Readonly domain?: string
  • providerName: string

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ConfigChangeEvent.html b/types/_openfeature_web_sdk.ConfigChangeEvent.html index 3987a1e65..afc3dcff2 100644 --- a/types/_openfeature_web_sdk.ConfigChangeEvent.html +++ b/types/_openfeature_web_sdk.ConfigChangeEvent.html @@ -1 +1 @@ -ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ErrorEvent.html b/types/_openfeature_web_sdk.ErrorEvent.html index c098b75c0..e674b4318 100644 --- a/types/_openfeature_web_sdk.ErrorEvent.html +++ b/types/_openfeature_web_sdk.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationContext.html b/types/_openfeature_web_sdk.EvaluationContext.html index b57c2ca45..3087b8878 100644 --- a/types/_openfeature_web_sdk.EvaluationContext.html +++ b/types/_openfeature_web_sdk.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationContextValue.html b/types/_openfeature_web_sdk.EvaluationContextValue.html index 345cc5f78..3200473cf 100644 --- a/types/_openfeature_web_sdk.EvaluationContextValue.html +++ b/types/_openfeature_web_sdk.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

    EvaluationContextValue: PrimitiveValue | Date | {
        [key: string]: EvaluationContextValue;
    } | EvaluationContextValue[]

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

    EvaluationContextValue: PrimitiveValue | Date | {
        [key: string]: EvaluationContextValue;
    } | EvaluationContextValue[]

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationDetails.html b/types/_openfeature_web_sdk.EvaluationDetails.html index 3e4d847c7..7e3488caa 100644 --- a/types/_openfeature_web_sdk.EvaluationDetails.html +++ b/types/_openfeature_web_sdk.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventContext.html b/types/_openfeature_web_sdk.EventContext.html index 024639b6a..5ed06d1c9 100644 --- a/types/_openfeature_web_sdk.EventContext.html +++ b/types/_openfeature_web_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<U>

    EventContext<U>: EventMap[ProviderEvents] & U

    Type Parameters

    • U extends Record<string, unknown> = Record<string, unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U>

    EventContext<U>: EventMap[ProviderEvents] & U

    Type Parameters

    • U extends Record<string, unknown> = Record<string, unknown>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventDetails.html b/types/_openfeature_web_sdk.EventDetails.html index 33706e518..665ec098c 100644 --- a/types/_openfeature_web_sdk.EventDetails.html +++ b/types/_openfeature_web_sdk.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation

    Type alias EventDetails

    EventDetails: EventContext & CommonEventDetails

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails

    EventDetails: EventContext & CommonEventDetails

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventHandler.html b/types/_openfeature_web_sdk.EventHandler.html index 0d15774d3..e33e2029a 100644 --- a/types/_openfeature_web_sdk.EventHandler.html +++ b/types/_openfeature_web_sdk.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation

    Type alias EventHandler

    EventHandler: ((eventDetails?) => Promise<unknown> | unknown)

    Type declaration

      • (eventDetails?): Promise<unknown> | unknown

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler

    EventHandler: ((eventDetails?) => Promise<unknown> | unknown)

    Type declaration

      • (eventDetails?): Promise<unknown> | unknown

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventMetadata.html b/types/_openfeature_web_sdk.EventMetadata.html index 47d89b62f..7ba3e1262 100644 --- a/types/_openfeature_web_sdk.EventMetadata.html +++ b/types/_openfeature_web_sdk.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation

    Type alias EventMetadata

    EventMetadata: {
        [key: string]: string | boolean | number;
    }

    Type declaration

    • [key: string]: string | boolean | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventMetadata | Documentation

    Type alias EventMetadata

    EventMetadata: {
        [key: string]: string | boolean | number;
    }

    Type declaration

    • [key: string]: string | boolean | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagMetadata.html b/types/_openfeature_web_sdk.FlagMetadata.html index 85112aa4b..7a5ff51f7 100644 --- a/types/_openfeature_web_sdk.FlagMetadata.html +++ b/types/_openfeature_web_sdk.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation

    Type alias FlagMetadata

    FlagMetadata: Record<string, string | number | boolean>

    A structure which supports definition of arbitrary properties, with keys of type string, and values of type boolean, string, or number.

    This structure is populated by a provider for use by an Application Author (via the Evaluation API) or an Application Integrator (via hooks).

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagValue.html b/types/_openfeature_web_sdk.FlagValue.html index 9c232aba2..d0f438f82 100644 --- a/types/_openfeature_web_sdk.FlagValue.html +++ b/types/_openfeature_web_sdk.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation

    Type alias FlagValue

    FlagValue: boolean | string | number | JsonValue

    Represents a JSON node value, or Date.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagValueType.html b/types/_openfeature_web_sdk.FlagValueType.html index 4199f78a5..416ecfd73 100644 --- a/types/_openfeature_web_sdk.FlagValueType.html +++ b/types/_openfeature_web_sdk.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation

    Type alias FlagValueType

    FlagValueType: "boolean" | "string" | "number" | "object"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

    FlagValueType: "boolean" | "string" | "number" | "object"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Hook.html b/types/_openfeature_web_sdk.Hook.html index aa7163893..65a9838ef 100644 --- a/types/_openfeature_web_sdk.Hook.html +++ b/types/_openfeature_web_sdk.Hook.html @@ -1 +1 @@ -Hook | Documentation

    Type alias Hook

    Hook: BaseHook<FlagValue, void, void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Hook | Documentation

    Type alias Hook

    Hook: BaseHook<FlagValue, void, void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.HookHints.html b/types/_openfeature_web_sdk.HookHints.html index d73dc7efe..c82222b8c 100644 --- a/types/_openfeature_web_sdk.HookHints.html +++ b/types/_openfeature_web_sdk.HookHints.html @@ -1 +1 @@ -HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonArray.html b/types/_openfeature_web_sdk.JsonArray.html index 24128e8d6..7fe41eae4 100644 --- a/types/_openfeature_web_sdk.JsonArray.html +++ b/types/_openfeature_web_sdk.JsonArray.html @@ -1 +1 @@ -JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonObject.html b/types/_openfeature_web_sdk.JsonObject.html index dbe22fbad..1911eac2d 100644 --- a/types/_openfeature_web_sdk.JsonObject.html +++ b/types/_openfeature_web_sdk.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation

    Type alias JsonObject

    JsonObject: {
        [key: string]: JsonValue;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

    JsonObject: {
        [key: string]: JsonValue;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonValue.html b/types/_openfeature_web_sdk.JsonValue.html index 4a7b56a96..fa3409236 100644 --- a/types/_openfeature_web_sdk.JsonValue.html +++ b/types/_openfeature_web_sdk.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Paradigm.html b/types/_openfeature_web_sdk.Paradigm.html index 30b11cf44..fc9e298b2 100644 --- a/types/_openfeature_web_sdk.Paradigm.html +++ b/types/_openfeature_web_sdk.Paradigm.html @@ -1,2 +1,2 @@ Paradigm | Documentation

    Type alias Paradigm

    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.PrimitiveValue.html b/types/_openfeature_web_sdk.PrimitiveValue.html index 52f43a78d..5a768ddb7 100644 --- a/types/_openfeature_web_sdk.PrimitiveValue.html +++ b/types/_openfeature_web_sdk.PrimitiveValue.html @@ -1 +1 @@ -PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ProviderEmittableEvents.html b/types/_openfeature_web_sdk.ProviderEmittableEvents.html index f62b01bec..31816ccc2 100644 --- a/types/_openfeature_web_sdk.ProviderEmittableEvents.html +++ b/types/_openfeature_web_sdk.ProviderEmittableEvents.html @@ -1,2 +1,2 @@ ProviderEmittableEvents | Documentation

    Type alias ProviderEmittableEvents

    ProviderEmittableEvents: Exclude<ProviderEvents, ContextChanged>

    A subset of events that can be directly emitted by providers.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ReadyEvent.html b/types/_openfeature_web_sdk.ReadyEvent.html index 583d43446..c118c0ae7 100644 --- a/types/_openfeature_web_sdk.ReadyEvent.html +++ b/types/_openfeature_web_sdk.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ResolutionDetails.html b/types/_openfeature_web_sdk.ResolutionDetails.html index 829e14551..24aabd58f 100644 --- a/types/_openfeature_web_sdk.ResolutionDetails.html +++ b/types/_openfeature_web_sdk.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ResolutionReason.html b/types/_openfeature_web_sdk.ResolutionReason.html index d503ea8bb..e8c662b53 100644 --- a/types/_openfeature_web_sdk.ResolutionReason.html +++ b/types/_openfeature_web_sdk.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation

    Type alias ResolutionReason

    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.StaleEvent.html b/types/_openfeature_web_sdk.StaleEvent.html index 75efc158c..26981b019 100644 --- a/types/_openfeature_web_sdk.StaleEvent.html +++ b/types/_openfeature_web_sdk.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_core.LOG_LEVELS.html b/variables/_openfeature_core.LOG_LEVELS.html index 184baf5fb..cde7199a4 100644 --- a/variables/_openfeature_core.LOG_LEVELS.html +++ b/variables/_openfeature_core.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_core.StandardResolutionReasons.html b/variables/_openfeature_core.StandardResolutionReasons.html index c775a7c5a..50f375c2a 100644 --- a/variables/_openfeature_core.StandardResolutionReasons.html +++ b/variables/_openfeature_core.StandardResolutionReasons.html @@ -7,4 +7,4 @@
  • Readonly STATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • Readonly TARGETING_MATCH: "TARGETING_MATCH"

    The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.

  • Readonly UNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.LOG_LEVELS.html b/variables/_openfeature_server_sdk.LOG_LEVELS.html index 59622b333..02def1965 100644 --- a/variables/_openfeature_server_sdk.LOG_LEVELS.html +++ b/variables/_openfeature_server_sdk.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.NOOP_PROVIDER.html b/variables/_openfeature_server_sdk.NOOP_PROVIDER.html index f6bbcad59..938ee4777 100644 --- a/variables/_openfeature_server_sdk.NOOP_PROVIDER.html +++ b/variables/_openfeature_server_sdk.NOOP_PROVIDER.html @@ -1 +1 @@ -NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html b/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html index d28ccddcb..2bcb3872b 100644 --- a/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html +++ b/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html @@ -1 +1 @@ -NOOP_TRANSACTION_CONTEXT_PROPAGATOR | Documentation

    Variable NOOP_TRANSACTION_CONTEXT_PROPAGATORConst

    NOOP_TRANSACTION_CONTEXT_PROPAGATOR: NoopTransactionContextPropagator = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NOOP_TRANSACTION_CONTEXT_PROPAGATOR | Documentation

    Variable NOOP_TRANSACTION_CONTEXT_PROPAGATORConst

    NOOP_TRANSACTION_CONTEXT_PROPAGATOR: NoopTransactionContextPropagator = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.OpenFeature.html b/variables/_openfeature_server_sdk.OpenFeature.html index 0de537f1b..319b9a7c1 100644 --- a/variables/_openfeature_server_sdk.OpenFeature.html +++ b/variables/_openfeature_server_sdk.OpenFeature.html @@ -1,3 +1,3 @@ OpenFeature | Documentation

    Variable OpenFeatureConst

    OpenFeature: OpenFeatureAPI = ...

    A singleton instance of the OpenFeature API.

    Returns

    OpenFeature API

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.StandardResolutionReasons.html b/variables/_openfeature_server_sdk.StandardResolutionReasons.html index b03a7ec95..afa3f652e 100644 --- a/variables/_openfeature_server_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_server_sdk.StandardResolutionReasons.html @@ -7,4 +7,4 @@
  • Readonly STATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • Readonly TARGETING_MATCH: "TARGETING_MATCH"

    The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.

  • Readonly UNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.LOG_LEVELS.html b/variables/_openfeature_web_sdk.LOG_LEVELS.html index 0f24207a4..948855c74 100644 --- a/variables/_openfeature_web_sdk.LOG_LEVELS.html +++ b/variables/_openfeature_web_sdk.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.NOOP_PROVIDER.html b/variables/_openfeature_web_sdk.NOOP_PROVIDER.html index 5c06ac5b5..6239ea38b 100644 --- a/variables/_openfeature_web_sdk.NOOP_PROVIDER.html +++ b/variables/_openfeature_web_sdk.NOOP_PROVIDER.html @@ -1 +1 @@ -NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.OpenFeature.html b/variables/_openfeature_web_sdk.OpenFeature.html index 76f57ddfe..bae8e2b11 100644 --- a/variables/_openfeature_web_sdk.OpenFeature.html +++ b/variables/_openfeature_web_sdk.OpenFeature.html @@ -1,3 +1,3 @@ OpenFeature | Documentation

    Variable OpenFeatureConst

    OpenFeature: OpenFeatureAPI = ...

    A singleton instance of the OpenFeature API.

    Returns

    OpenFeature API

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.StandardResolutionReasons.html b/variables/_openfeature_web_sdk.StandardResolutionReasons.html index 5e7575db2..5e2d78cde 100644 --- a/variables/_openfeature_web_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_web_sdk.StandardResolutionReasons.html @@ -7,4 +7,4 @@
  • Readonly STATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • Readonly TARGETING_MATCH: "TARGETING_MATCH"

    The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.

  • Readonly UNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file