From 274a46366b7b95b444bc2938068ef2c59750c14b Mon Sep 17 00:00:00 2001 From: lukas-reining Date: Sat, 14 Sep 2024 07:03:41 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=208bdc1?= =?UTF-8?q?6430ca08fbf30d2486987657724701eff67=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 | 24 ++++---- .../_openfeature_core.OpenFeatureError.html | 4 +- classes/_openfeature_core.ParseError.html | 4 +- .../_openfeature_core.ProviderFatalError.html | 4 +- ...penfeature_core.ProviderNotReadyError.html | 4 +- .../_openfeature_core.ProviderWrapper.html | 4 +- classes/_openfeature_core.SafeLogger.html | 4 +- ...feature_core.TargetingKeyMissingError.html | 4 +- .../_openfeature_core.TypeMismatchError.html | 4 +- ...alStorageTransactionContextPropagator.html | 8 +-- ..._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 ++++++++-------- ...ature_server_sdk.OpenFeatureCommonAPI.html | 24 ++++---- ...enfeature_server_sdk.OpenFeatureError.html | 4 +- ...re_server_sdk.OpenFeatureEventEmitter.html | 6 +- .../_openfeature_server_sdk.ParseError.html | 4 +- ...feature_server_sdk.ProviderFatalError.html | 4 +- ...ture_server_sdk.ProviderNotReadyError.html | 4 +- ...penfeature_server_sdk.ProviderWrapper.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 | 18 +++--- ...enfeature_web_sdk.InvalidContextError.html | 4 +- .../_openfeature_web_sdk.OpenFeatureAPI.html | 58 +++++++++---------- ...nfeature_web_sdk.OpenFeatureCommonAPI.html | 24 ++++---- ..._openfeature_web_sdk.OpenFeatureError.html | 4 +- ...ature_web_sdk.OpenFeatureEventEmitter.html | 6 +- classes/_openfeature_web_sdk.ParseError.html | 4 +- ...penfeature_web_sdk.ProviderFatalError.html | 4 +- ...feature_web_sdk.ProviderNotReadyError.html | 4 +- .../_openfeature_web_sdk.ProviderWrapper.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 | 14 ++--- ...openfeature_core.ClientProviderStatus.html | 14 ++--- enums/_openfeature_core.ErrorCode.html | 18 +++--- ...openfeature_core.ServerProviderEvents.html | 10 ++-- ...openfeature_core.ServerProviderStatus.html | 12 ++-- ...ature_server_sdk.ClientProviderEvents.html | 14 ++--- ...ature_server_sdk.ClientProviderStatus.html | 14 ++--- enums/_openfeature_server_sdk.ErrorCode.html | 18 +++--- ...openfeature_server_sdk.ProviderEvents.html | 10 ++-- ...openfeature_server_sdk.ProviderStatus.html | 12 ++-- enums/_openfeature_web_sdk.ErrorCode.html | 18 +++--- .../_openfeature_web_sdk.ProviderEvents.html | 14 ++--- .../_openfeature_web_sdk.ProviderStatus.html | 14 ++--- ...nfeature_web_sdk.ServerProviderEvents.html | 10 ++-- ...nfeature_web_sdk.ServerProviderStatus.html | 12 ++-- ...ture_core.instantiateErrorByErrorCode.html | 2 +- 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 +- ...erver_sdk.instantiateErrorByErrorCode.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 +- ...e_web_sdk.instantiateErrorByErrorCode.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 +- ...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 | 40 ++++++------- ...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.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.Provider.html | 24 ++++---- ...nfeature_web_sdk.ProviderEventEmitter.html | 6 +- ..._openfeature_web_sdk.ProviderMetadata.html | 4 +- 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.Metadata.html | 2 +- types/_openfeature_core.NotChangeEvents.html | 2 +- types/_openfeature_core.Paradigm.html | 2 +- types/_openfeature_core.PrimitiveValue.html | 2 +- types/_openfeature_core.ReadyEvent.html | 2 +- types/_openfeature_core.ReconcilingEvent.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.Metadata.html | 2 +- ...penfeature_server_sdk.NotChangeEvents.html | 2 +- types/_openfeature_server_sdk.Paradigm.html | 2 +- ...openfeature_server_sdk.PrimitiveValue.html | 2 +- types/_openfeature_server_sdk.ReadyEvent.html | 2 +- ...enfeature_server_sdk.ReconcilingEvent.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.Metadata.html | 2 +- .../_openfeature_web_sdk.NotChangeEvents.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.ReconcilingEvent.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 +- 224 files changed, 619 insertions(+), 619 deletions(-) diff --git a/classes/_openfeature_core.DefaultLogger.html b/classes/_openfeature_core.DefaultLogger.html index 442da54c3..18566474b 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

constructordebugerrorinfowarn
\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

constructordebugerrorinfowarn
\ No newline at end of file diff --git a/classes/_openfeature_core.FlagNotFoundError.html b/classes/_openfeature_core.FlagNotFoundError.html index 22bd4f8e2..2e3be4db8 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.GeneralError.html b/classes/_openfeature_core.GeneralError.html index 413664473..3ebc40074 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.GenericEventEmitter.html b/classes/_openfeature_core.GenericEventEmitter.html index 0f17cd387..d20a94468 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<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_ERROR: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_READY: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_RECONCILING: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_STALE: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
} = ...

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<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_ERROR: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_READY: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_RECONCILING: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_STALE: WeakMap<EventHandler<ServerProviderEvents | ClientProviderEvents>, EventHandler<ServerProviderEvents | ClientProviderEvents>[]>;
} = ...

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

constructor_eventLogger_handlerseventEmitterglobalLogger_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructor_eventLogger_handlerseventEmitterglobalLogger_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file diff --git a/classes/_openfeature_core.InvalidContextError.html b/classes/_openfeature_core.InvalidContextError.html index 0f622c4e2..9855021d5 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.OpenFeatureCommonAPI.html b/classes/_openfeature_core.OpenFeatureCommonAPI.html index 3feae0be2..fbf9d58c0 100644 --- a/classes/_openfeature_core.OpenFeatureCommonAPI.html +++ b/classes/_openfeature_core.OpenFeatureCommonAPI.html @@ -1,4 +1,4 @@ -OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Implements

Constructors

constructor

Properties

_apiEmitter _clientEventHandlers _clientEvents @@ -33,39 +33,39 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _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: 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

Protected 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

Protected setAwaitableProvider

setLogger

Abstract setProvider

Abstract setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEventHandlers_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumTypeallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetUnboundEmittershandleShutdownErrorremoveHandlersetAwaitableProvidersetLoggersetProvidersetProviderAndWaittransferListeners
\ No newline at end of file +

Abstract setProvider

Abstract setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEventHandlers_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumTypeallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetUnboundEmittershandleShutdownErrorremoveHandlersetAwaitableProvidersetLoggersetProvidersetProviderAndWaittransferListeners
\ No newline at end of file diff --git a/classes/_openfeature_core.OpenFeatureError.html b/classes/_openfeature_core.OpenFeatureError.html index 334504cfd..cdb5032eb 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.ParseError.html b/classes/_openfeature_core.ParseError.html index 64a8c8897..1e404888a 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.ProviderFatalError.html b/classes/_openfeature_core.ProviderFatalError.html index 7fecd99d4..3ba66961f 100644 --- a/classes/_openfeature_core.ProviderFatalError.html +++ b/classes/_openfeature_core.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Class ProviderFatalError

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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.ProviderNotReadyError.html b/classes/_openfeature_core.ProviderNotReadyError.html index 0bb550b7a..2787d5955 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.ProviderWrapper.html b/classes/_openfeature_core.ProviderWrapper.html index 7525fe9e2..8f62b01d0 100644 --- a/classes/_openfeature_core.ProviderWrapper.html +++ b/classes/_openfeature_core.ProviderWrapper.html @@ -1,6 +1,6 @@ ProviderWrapper | Documentation

Class ProviderWrapper<P, S>

A provider and its current status. For internal use only.

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor +

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor

Properties

_pendingContextChanges _provider _status @@ -9,4 +9,4 @@ status

Methods

decrementPendingContextChanges incrementPendingContextChanges -

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

constructor_pendingContextChanges_provider_statusallContextChangesSettledproviderstatusdecrementPendingContextChangesincrementPendingContextChanges
\ No newline at end of file +

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

constructor_pendingContextChanges_provider_statusallContextChangesSettledproviderstatusdecrementPendingContextChangesincrementPendingContextChanges
\ No newline at end of file diff --git a/classes/_openfeature_core.SafeLogger.html b/classes/_openfeature_core.SafeLogger.html index e447a3335..e0d9b4704 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

constructorfallbackLoggerloggerdebugerrorinfologwarn
\ 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

constructorfallbackLoggerloggerdebugerrorinfologwarn
\ No newline at end of file diff --git a/classes/_openfeature_core.TargetingKeyMissingError.html b/classes/_openfeature_core.TargetingKeyMissingError.html index 642818ffc..17b7022ba 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_core.TypeMismatchError.html b/classes/_openfeature_core.TypeMismatchError.html index 62e887e06..2765abbcb 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html b/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html index 8cc291e77..e4e44ae05 100644 --- a/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html +++ b/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html @@ -1,11 +1,11 @@ -AsyncLocalStorageTransactionContextPropagator | Documentation

Class AsyncLocalStorageTransactionContextPropagator

Implements

Constructors

constructor +AsyncLocalStorageTransactionContextPropagator | Documentation

Class AsyncLocalStorageTransactionContextPropagator

Implements

Constructors

constructor

Properties

asyncLocalStorage

Methods

getTransactionContext setTransactionContext -

Constructors

constructor

Properties

Private asyncLocalStorage

asyncLocalStorage: AsyncLocalStorage<EvaluationContext> = ...

Methods

getTransactionContext

  • getTransactionContext(): EvaluationContext

  • Returns the currently defined transaction context using the registered transaction +

Constructors

constructor

Properties

Private asyncLocalStorage

asyncLocalStorage: AsyncLocalStorage<EvaluationContext> = ...

Methods

getTransactionContext

setTransactionContext

setTransactionContext

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

  • Sets the transaction context using the registered transaction context propagator. Runs the callback function, in which the transactionContext will be available by calling this#getTransactionContext.

    The TransactionContextPropagator must persist the transactionContext and make it available @@ -19,4 +19,4 @@

Parameters

  • transactionContext: EvaluationContext

    The transaction specific context

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

    Callback function to run

      • (...args): R

      • Parameters

        Returns R

  • Rest ...args: TArgs

    Optional arguments that are passed to the callback function

    -

Returns void

Settings

Member Visibility

Theme

On This Page

constructorasyncLocalStoragegetTransactionContextsetTransactionContext
\ No newline at end of file +

Returns void

Settings

Member Visibility

Theme

On This Page

constructorasyncLocalStoragegetTransactionContextsetTransactionContext
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.DefaultLogger.html b/classes/_openfeature_server_sdk.DefaultLogger.html index c58de1b16..330325745 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

constructordebugerrorinfowarn
\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

constructordebugerrorinfowarn
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.FlagNotFoundError.html b/classes/_openfeature_server_sdk.FlagNotFoundError.html index eb1b05714..1d2d25543 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.GeneralError.html b/classes/_openfeature_server_sdk.GeneralError.html index 905a09469..d9ba6ad21 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.GenericEventEmitter.html b/classes/_openfeature_server_sdk.GenericEventEmitter.html index 14b9ca1fa..6158d5adb 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<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_ERROR: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_READY: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_RECONCILING: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_STALE: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
} = ...

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<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_ERROR: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_READY: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_RECONCILING: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
    PROVIDER_STALE: WeakMap<EventHandler<ProviderEvents | ClientProviderEvents>, EventHandler<ProviderEvents | ClientProviderEvents>[]>;
} = ...

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

constructor_eventLogger_handlerseventEmitterglobalLogger_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructor_eventLogger_handlerseventEmitterglobalLogger_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.InMemoryProvider.html b/classes/_openfeature_server_sdk.InMemoryProvider.html index a18b4c351..8c4641a54 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

constructor_flagConfigurationeventsmetadatarunsOnlookupFlagValueputConfigurationresolveBooleanEvaluationresolveFlagWithReasonresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
\ No newline at end of file +

Returns void

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

constructor_flagConfigurationeventsmetadatarunsOnlookupFlagValueputConfigurationresolveBooleanEvaluationresolveFlagWithReasonresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.InvalidContextError.html b/classes/_openfeature_server_sdk.InvalidContextError.html index 0edd4ad41..7b4384f25 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureAPI.html b/classes/_openfeature_server_sdk.OpenFeatureAPI.html index c37bed4c0..e59ff221e 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

_apiEmitter _clientEvents _context @@ -38,31 +38,31 @@ setProviderAndWait setTransactionContext setTransactionContextPropagator -

Constructors

Private constructor

Properties

Protected _apiEmitter

_apiEmitter: OpenFeatureEventEmitter = ...

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _apiEmitter

_apiEmitter: OpenFeatureEventEmitter = ...

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

Private allProviders

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. @@ -70,7 +70,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. @@ -79,55 +79,55 @@

  • 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

Private getProviderStatus

getTransactionContext

Private getProviderStatus

getTransactionContext

removeHandler

removeHandler

Protected setAwaitableProvider

setContext

Returns void

Protected setAwaitableProvider

setContext

setLogger

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

setTransactionContext

setTransactionContext

Parameters

Returns void

setTransactionContextPropagator

Returns void

setTransactionContextPropagator

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumType_transactionContextPropagatorallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetClientgetContextgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetProviderStatusgetTransactionContextremoveHandlersetAwaitableProvidersetContextsetLoggersetProvidersetProviderAndWaitsetTransactionContextsetTransactionContextPropagator
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumType_transactionContextPropagatorallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetClientgetContextgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetProviderStatusgetTransactionContextremoveHandlersetAwaitableProvidersetContextsetLoggersetProvidersetProviderAndWaitsetTransactionContextsetTransactionContextPropagator
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html b/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html index b764e1582..bc1114bae 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html +++ b/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html @@ -1,4 +1,4 @@ -OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_apiEmitter _clientEventHandlers _clientEvents @@ -33,39 +33,39 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ProviderStatus

Accessors

Private allProviders

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _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: 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

Protected 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

Protected setAwaitableProvider

setLogger

Abstract setProvider

Abstract setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEventHandlers_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumTypeallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetUnboundEmittershandleShutdownErrorremoveHandlersetAwaitableProvidersetLoggersetProvidersetProviderAndWaittransferListeners
\ No newline at end of file +

Abstract setProvider

Abstract setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEventHandlers_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumTypeallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetUnboundEmittershandleShutdownErrorremoveHandlersetAwaitableProvidersetLoggersetProvidersetProviderAndWaittransferListeners
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureError.html b/classes/_openfeature_server_sdk.OpenFeatureError.html index f8e96d002..38578c359 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html index 0ea0ba47f..a77111c9d 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<DefaultEventMap> = ...

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<DefaultEventMap> = ...

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

constructoreventEmitter_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoreventEmitter_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ParseError.html b/classes/_openfeature_server_sdk.ParseError.html index 0ac41b150..431e83068 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ProviderFatalError.html b/classes/_openfeature_server_sdk.ProviderFatalError.html index 06dac0dca..a732887a2 100644 --- a/classes/_openfeature_server_sdk.ProviderFatalError.html +++ b/classes/_openfeature_server_sdk.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Class ProviderFatalError

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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ProviderNotReadyError.html b/classes/_openfeature_server_sdk.ProviderNotReadyError.html index 41c320dc7..f175e8ea7 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ProviderWrapper.html b/classes/_openfeature_server_sdk.ProviderWrapper.html index 9b1ca9930..2532417ff 100644 --- a/classes/_openfeature_server_sdk.ProviderWrapper.html +++ b/classes/_openfeature_server_sdk.ProviderWrapper.html @@ -1,6 +1,6 @@ ProviderWrapper | Documentation

Class ProviderWrapper<P, S>

A provider and its current status. For internal use only.

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor +

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor

Properties

_pendingContextChanges _provider _status @@ -9,4 +9,4 @@ status

Methods

decrementPendingContextChanges incrementPendingContextChanges -

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

constructor_pendingContextChanges_provider_statusallContextChangesSettledproviderstatusdecrementPendingContextChangesincrementPendingContextChanges
\ No newline at end of file +

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

constructor_pendingContextChanges_provider_statusallContextChangesSettledproviderstatusdecrementPendingContextChangesincrementPendingContextChanges
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.SafeLogger.html b/classes/_openfeature_server_sdk.SafeLogger.html index 152829da8..fe98ce18f 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

constructorfallbackLoggerloggerdebugerrorinfologwarn
\ 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

constructorfallbackLoggerloggerdebugerrorinfologwarn
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.TargetingKeyMissingError.html b/classes/_openfeature_server_sdk.TargetingKeyMissingError.html index ac18cf0cc..19b1118b5 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.TypeMismatchError.html b/classes/_openfeature_server_sdk.TypeMismatchError.html index 3276cca91..4fbee0461 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.DefaultLogger.html b/classes/_openfeature_web_sdk.DefaultLogger.html index d70cc5f92..e705428d4 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

constructordebugerrorinfowarn
\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

constructordebugerrorinfowarn
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.FlagNotFoundError.html b/classes/_openfeature_web_sdk.FlagNotFoundError.html index 1575f764b..447a3b201 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.GeneralError.html b/classes/_openfeature_web_sdk.GeneralError.html index 4f4be9ec2..b9052f4d1 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.GenericEventEmitter.html b/classes/_openfeature_web_sdk.GenericEventEmitter.html index b940312dd..b000f9236 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<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_ERROR: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_READY: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_RECONCILING: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_STALE: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
} = ...

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<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_CONTEXT_CHANGED: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_ERROR: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_READY: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_RECONCILING: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
    PROVIDER_STALE: WeakMap<EventHandler<ServerProviderEvents | ProviderEvents>, EventHandler<ServerProviderEvents | ProviderEvents>[]>;
} = ...

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

constructor_eventLogger_handlerseventEmitterglobalLogger_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructor_eventLogger_handlerseventEmitterglobalLogger_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.InMemoryProvider.html b/classes/_openfeature_web_sdk.InMemoryProvider.html index a9a81f7a2..3a938fb62 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 @@ -13,14 +13,14 @@ 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.

-

Methods

Private lookupFlagValue

putConfiguration

Methods

Private lookupFlagValue

putConfiguration

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

constructor_context_flagConfigurationeventsmetadatarunsOnlookupFlagValueputConfigurationresolveAndCheckFlagresolveBooleanEvaluationresolveFlagWithReasonresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
\ No newline at end of file +

Returns Promise<void>

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

constructor_context_flagConfigurationeventsmetadatarunsOnlookupFlagValueputConfigurationresolveAndCheckFlagresolveBooleanEvaluationresolveFlagWithReasonresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.InvalidContextError.html b/classes/_openfeature_web_sdk.InvalidContextError.html index fff6a72e2..b785c70bf 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureAPI.html b/classes/_openfeature_web_sdk.OpenFeatureAPI.html index ad1852a9e..b800da97e 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

_apiEmitter _clientEvents _context @@ -37,30 +37,30 @@ setLogger setProvider setProviderAndWait -

Constructors

Private constructor

Properties

Protected _apiEmitter

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _apiEmitter

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

Private allProviders

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

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

Private getProviderStatus

removeHandler

Private getProviderStatus

removeHandler

Private runProviderContextChangeHandler

Protected setAwaitableProvider

setContext

Returns void

Private runProviderContextChangeHandler

Protected setAwaitableProvider

setContext

setLogger

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumTypeallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearContextclearContextsclearHandlersclearHooksclearProvidersclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetClientgetContextgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetProviderStatusremoveHandlerrunProviderContextChangeHandlersetAwaitableProvidersetContextsetLoggersetProvidersetProviderAndWait
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

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

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_apiEmitter _clientEventHandlers _clientEvents @@ -33,39 +33,39 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _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: 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

Protected 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

Protected setAwaitableProvider

setLogger

Abstract setProvider

Abstract setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEventHandlers_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumTypeallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetUnboundEmittershandleShutdownErrorremoveHandlersetAwaitableProvidersetLoggersetProvidersetProviderAndWaittransferListeners
\ No newline at end of file +

Abstract setProvider

Abstract setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

constructor_apiEmitter_clientEventHandlers_clientEvents_context_defaultProvider_domainScopedContext_domainScopedProviders_hooks_logger_runsOn_statusEnumTypeallProvidersproviderMetadata_createEventEmitteraddHandleraddHooksbuildAndCacheEventEmitterForClientclearHandlersclearHooksclearProvidersAndSetDefaultclosegetAssociatedEventEmittersgetHandlersgetHooksgetProviderForClientgetProviderMetadatagetUnboundEmittershandleShutdownErrorremoveHandlersetAwaitableProvidersetLoggersetProvidersetProviderAndWaittransferListeners
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureError.html b/classes/_openfeature_web_sdk.OpenFeatureError.html index 5fc96b1d1..80eb0b039 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html index 2b01da1d5..b850e341f 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<string | symbol, any> = ...

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<string | symbol, any> = ...

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

constructoreventEmitter_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

constructoreventEmitter_loggeraddHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ParseError.html b/classes/_openfeature_web_sdk.ParseError.html index 385cabb0c..588cc3754 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ProviderFatalError.html b/classes/_openfeature_web_sdk.ProviderFatalError.html index b9db6246b..71ce4fad2 100644 --- a/classes/_openfeature_web_sdk.ProviderFatalError.html +++ b/classes/_openfeature_web_sdk.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Class ProviderFatalError

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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ProviderNotReadyError.html b/classes/_openfeature_web_sdk.ProviderNotReadyError.html index f412efbd5..bd35f5f24 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ProviderWrapper.html b/classes/_openfeature_web_sdk.ProviderWrapper.html index 1cb9031d3..f6d842dad 100644 --- a/classes/_openfeature_web_sdk.ProviderWrapper.html +++ b/classes/_openfeature_web_sdk.ProviderWrapper.html @@ -1,6 +1,6 @@ ProviderWrapper | Documentation

Class ProviderWrapper<P, S>

A provider and its current status. For internal use only.

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor +

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor

Properties

_pendingContextChanges _provider _status @@ -9,4 +9,4 @@ status

Methods

decrementPendingContextChanges incrementPendingContextChanges -

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

constructor_pendingContextChanges_provider_statusallContextChangesSettledproviderstatusdecrementPendingContextChangesincrementPendingContextChanges
\ No newline at end of file +

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

constructor_pendingContextChanges_provider_statusallContextChangesSettledproviderstatusdecrementPendingContextChangesincrementPendingContextChanges
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.SafeLogger.html b/classes/_openfeature_web_sdk.SafeLogger.html index 8d8f03268..0b5143d69 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

constructorfallbackLoggerloggerdebugerrorinfologwarn
\ 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

constructorfallbackLoggerloggerdebugerrorinfologwarn
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html index 20e4a9c4f..099d91f25 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.TypeMismatchError.html b/classes/_openfeature_web_sdk.TypeMismatchError.html index a1ef7c317..293d3d956 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

    • (err, stackTraces): any

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorcausecodemessagenamestackprepareStackTracestackTraceLimitcaptureStackTrace
\ No newline at end of file diff --git a/enums/_openfeature_core.ClientProviderEvents.html b/enums/_openfeature_core.ClientProviderEvents.html index 7a878f80d..c43841d02 100644 --- a/enums/_openfeature_core.ClientProviderEvents.html +++ b/enums/_openfeature_core.ClientProviderEvents.html @@ -1,14 +1,14 @@ ClientProviderEvents | Documentation

Enumeration ClientProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Reconciling 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.

-

Reconciling

Reconciling: "PROVIDER_RECONCILING"

The context associated with the provider has changed, and the provider has not yet reconciled its associated state.

-

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

ConfigurationChangedContextChangedErrorReadyReconcilingStale
\ 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.

+

Reconciling

Reconciling: "PROVIDER_RECONCILING"

The context associated with the provider has changed, and the provider has not yet reconciled its associated state.

+

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

ConfigurationChangedContextChangedErrorReadyReconcilingStale
\ No newline at end of file diff --git a/enums/_openfeature_core.ClientProviderStatus.html b/enums/_openfeature_core.ClientProviderStatus.html index 61fd84d28..558e7b339 100644 --- a/enums/_openfeature_core.ClientProviderStatus.html +++ b/enums/_openfeature_core.ClientProviderStatus.html @@ -1,15 +1,15 @@ ClientProviderStatus | Documentation

Enumeration ClientProviderStatus

The state of the provider. Note that the provider's state is handled by the SDK.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY RECONCILING STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

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.

-

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

-

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

ERRORFATALNOT_READYREADYRECONCILINGSTALE
\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

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.

+

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

+

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

ERRORFATALNOT_READYREADYRECONCILINGSTALE
\ No newline at end of file diff --git a/enums/_openfeature_core.ErrorCode.html b/enums/_openfeature_core.ErrorCode.html index 4d2875059..55f7846c3 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 @@ -7,11 +7,11 @@ 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_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

-

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

FLAG_NOT_FOUNDGENERALINVALID_CONTEXTPARSE_ERRORPROVIDER_FATALPROVIDER_NOT_READYTARGETING_KEY_MISSINGTYPE_MISMATCH
\ 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_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

+

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

FLAG_NOT_FOUNDGENERALINVALID_CONTEXTPARSE_ERRORPROVIDER_FATALPROVIDER_NOT_READYTARGETING_KEY_MISSINGTYPE_MISMATCH
\ No newline at end of file diff --git a/enums/_openfeature_core.ServerProviderEvents.html b/enums/_openfeature_core.ServerProviderEvents.html index ad3472e89..c4be749e8 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

ConfigurationChangedErrorReadyStale
\ 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

ConfigurationChangedErrorReadyStale
\ No newline at end of file diff --git a/enums/_openfeature_core.ServerProviderStatus.html b/enums/_openfeature_core.ServerProviderStatus.html index 9c3260fd3..99291b65f 100644 --- a/enums/_openfeature_core.ServerProviderStatus.html +++ b/enums/_openfeature_core.ServerProviderStatus.html @@ -1,13 +1,13 @@ ServerProviderStatus | Documentation

Enumeration ServerProviderStatus

The state of the provider. Note that the provider's state is handled by the SDK.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

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

ERRORFATALNOT_READYREADYSTALE
\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

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

ERRORFATALNOT_READYREADYSTALE
\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ClientProviderEvents.html b/enums/_openfeature_server_sdk.ClientProviderEvents.html index 215c21fea..039b0f9c4 100644 --- a/enums/_openfeature_server_sdk.ClientProviderEvents.html +++ b/enums/_openfeature_server_sdk.ClientProviderEvents.html @@ -1,14 +1,14 @@ ClientProviderEvents | Documentation

Enumeration ClientProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Reconciling 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.

-

Reconciling

Reconciling: "PROVIDER_RECONCILING"

The context associated with the provider has changed, and the provider has not yet reconciled its associated state.

-

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

ConfigurationChangedContextChangedErrorReadyReconcilingStale
\ 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.

+

Reconciling

Reconciling: "PROVIDER_RECONCILING"

The context associated with the provider has changed, and the provider has not yet reconciled its associated state.

+

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

ConfigurationChangedContextChangedErrorReadyReconcilingStale
\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ClientProviderStatus.html b/enums/_openfeature_server_sdk.ClientProviderStatus.html index 605eb3e50..9b4c1a432 100644 --- a/enums/_openfeature_server_sdk.ClientProviderStatus.html +++ b/enums/_openfeature_server_sdk.ClientProviderStatus.html @@ -1,15 +1,15 @@ ClientProviderStatus | Documentation

Enumeration ClientProviderStatus

The state of the provider. Note that the provider's state is handled by the SDK.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY RECONCILING STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

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.

-

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

-

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

ERRORFATALNOT_READYREADYRECONCILINGSTALE
\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

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.

+

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

+

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

ERRORFATALNOT_READYREADYRECONCILINGSTALE
\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ErrorCode.html b/enums/_openfeature_server_sdk.ErrorCode.html index 8270ca6b0..1986ff4f2 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 @@ -7,11 +7,11 @@ 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_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

-

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

FLAG_NOT_FOUNDGENERALINVALID_CONTEXTPARSE_ERRORPROVIDER_FATALPROVIDER_NOT_READYTARGETING_KEY_MISSINGTYPE_MISMATCH
\ 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_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

+

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

FLAG_NOT_FOUNDGENERALINVALID_CONTEXTPARSE_ERRORPROVIDER_FATALPROVIDER_NOT_READYTARGETING_KEY_MISSINGTYPE_MISMATCH
\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ProviderEvents.html b/enums/_openfeature_server_sdk.ProviderEvents.html index 80c55c232..17c8fb539 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

ConfigurationChangedErrorReadyStale
\ 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

ConfigurationChangedErrorReadyStale
\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ProviderStatus.html b/enums/_openfeature_server_sdk.ProviderStatus.html index db1f40a89..fb9df5075 100644 --- a/enums/_openfeature_server_sdk.ProviderStatus.html +++ b/enums/_openfeature_server_sdk.ProviderStatus.html @@ -1,13 +1,13 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider. Note that the provider's state is handled by the SDK.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

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

ERRORFATALNOT_READYREADYSTALE
\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

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

ERRORFATALNOT_READYREADYSTALE
\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ErrorCode.html b/enums/_openfeature_web_sdk.ErrorCode.html index 8e3134b0c..10b8f3a76 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 @@ -7,11 +7,11 @@ 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_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

-

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

FLAG_NOT_FOUNDGENERALINVALID_CONTEXTPARSE_ERRORPROVIDER_FATALPROVIDER_NOT_READYTARGETING_KEY_MISSINGTYPE_MISMATCH
\ 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_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

+

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

FLAG_NOT_FOUNDGENERALINVALID_CONTEXTPARSE_ERRORPROVIDER_FATALPROVIDER_NOT_READYTARGETING_KEY_MISSINGTYPE_MISMATCH
\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ProviderEvents.html b/enums/_openfeature_web_sdk.ProviderEvents.html index 3d2ace2d5..f7899a92d 100644 --- a/enums/_openfeature_web_sdk.ProviderEvents.html +++ b/enums/_openfeature_web_sdk.ProviderEvents.html @@ -1,14 +1,14 @@ ProviderEvents | Documentation

Enumeration ProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Reconciling 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.

-

Reconciling

Reconciling: "PROVIDER_RECONCILING"

The context associated with the provider has changed, and the provider has not yet reconciled its associated state.

-

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

ConfigurationChangedContextChangedErrorReadyReconcilingStale
\ 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.

+

Reconciling

Reconciling: "PROVIDER_RECONCILING"

The context associated with the provider has changed, and the provider has not yet reconciled its associated state.

+

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

ConfigurationChangedContextChangedErrorReadyReconcilingStale
\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ProviderStatus.html b/enums/_openfeature_web_sdk.ProviderStatus.html index f3612c185..dc4fc3c15 100644 --- a/enums/_openfeature_web_sdk.ProviderStatus.html +++ b/enums/_openfeature_web_sdk.ProviderStatus.html @@ -1,15 +1,15 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider. Note that the provider's state is handled by the SDK.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY RECONCILING STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

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.

-

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

-

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

ERRORFATALNOT_READYREADYRECONCILINGSTALE
\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

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.

+

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

+

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

ERRORFATALNOT_READYREADYRECONCILINGSTALE
\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ServerProviderEvents.html b/enums/_openfeature_web_sdk.ServerProviderEvents.html index 8fb2757be..effc3adfc 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

ConfigurationChangedErrorReadyStale
\ 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

ConfigurationChangedErrorReadyStale
\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ServerProviderStatus.html b/enums/_openfeature_web_sdk.ServerProviderStatus.html index fba0c4bab..4789c2c83 100644 --- a/enums/_openfeature_web_sdk.ServerProviderStatus.html +++ b/enums/_openfeature_web_sdk.ServerProviderStatus.html @@ -1,13 +1,13 @@ ServerProviderStatus | Documentation

Enumeration ServerProviderStatus

The state of the provider. Note that the provider's state is handled by the SDK.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

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

ERRORFATALNOT_READYREADYSTALE
\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

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

ERRORFATALNOT_READYREADYSTALE
\ No newline at end of file diff --git a/functions/_openfeature_core.instantiateErrorByErrorCode.html b/functions/_openfeature_core.instantiateErrorByErrorCode.html index 4d917fe02..5ea7f7cc4 100644 --- a/functions/_openfeature_core.instantiateErrorByErrorCode.html +++ b/functions/_openfeature_core.instantiateErrorByErrorCode.html @@ -1 +1 @@ -instantiateErrorByErrorCode | Documentation

Function instantiateErrorByErrorCode

Settings

Member Visibility

Theme

\ No newline at end of file +instantiateErrorByErrorCode | Documentation

Function instantiateErrorByErrorCode

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_core.isObject.html b/functions/_openfeature_core.isObject.html index 7b27c831a..575f628a7 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_core.isString.html b/functions/_openfeature_core.isString.html index 3be422ca1..cf87ed5a5 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_core.objectOrUndefined.html b/functions/_openfeature_core.objectOrUndefined.html index 76fde5a55..d6af26425 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_core.statusMatchesEvent.html b/functions/_openfeature_core.statusMatchesEvent.html index 1501af91e..67c7caf89 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_core.stringOrUndefined.html b/functions/_openfeature_core.stringOrUndefined.html index 722de1566..db28d0455 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html b/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html index a640b3176..b248d5f09 100644 --- a/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html +++ b/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html @@ -1 +1 @@ -instantiateErrorByErrorCode | Documentation

Function instantiateErrorByErrorCode

Settings

Member Visibility

Theme

\ No newline at end of file +instantiateErrorByErrorCode | Documentation

Function instantiateErrorByErrorCode

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.isObject.html b/functions/_openfeature_server_sdk.isObject.html index 2a5c155b0..59b5a3acd 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.isString.html b/functions/_openfeature_server_sdk.isString.html index b18820208..896b5cf10 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.objectOrUndefined.html b/functions/_openfeature_server_sdk.objectOrUndefined.html index 39d308af6..e329e52ee 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.statusMatchesEvent.html b/functions/_openfeature_server_sdk.statusMatchesEvent.html index add2c2f11..faf45848f 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.stringOrUndefined.html b/functions/_openfeature_server_sdk.stringOrUndefined.html index a8bb66b61..9af663192 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html b/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html index 7e8b44816..c2f2d7e87 100644 --- a/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html +++ b/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html @@ -1 +1 @@ -instantiateErrorByErrorCode | Documentation

Function instantiateErrorByErrorCode

Settings

Member Visibility

Theme

\ No newline at end of file +instantiateErrorByErrorCode | Documentation

Function instantiateErrorByErrorCode

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.isObject.html b/functions/_openfeature_web_sdk.isObject.html index ecd769eb4..cdf6c57f0 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.isString.html b/functions/_openfeature_web_sdk.isString.html index 81f6cf88a..e2609435e 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.objectOrUndefined.html b/functions/_openfeature_web_sdk.objectOrUndefined.html index 59f9a4f3a..312d86604 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.statusMatchesEvent.html b/functions/_openfeature_web_sdk.statusMatchesEvent.html index 13f887eb5..562b5b2f4 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.stringOrUndefined.html b/functions/_openfeature_web_sdk.stringOrUndefined.html index 544aaa196..f7e08dd7d 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

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/interfaces/_openfeature_core.BaseHook.html b/interfaces/_openfeature_core.BaseHook.html index 33430be73..a4df7af2a 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

afterbeforeerrorfinally
\ 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

afterbeforeerrorfinally
\ No newline at end of file diff --git a/interfaces/_openfeature_core.BeforeHookContext.html b/interfaces/_openfeature_core.BeforeHookContext.html index c8f6f147e..290dd5209 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

clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
\ 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

clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
\ No newline at end of file diff --git a/interfaces/_openfeature_core.ClientMetadata.html b/interfaces/_openfeature_core.ClientMetadata.html index fa21e5760..fa49a2dbb 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;
}

Properties

domain? +ClientMetadata | Documentation

Interface ClientMetadata

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

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

domainnameproviderMetadataversion
\ 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

domainnameproviderMetadataversion
\ No newline at end of file diff --git a/interfaces/_openfeature_core.CommonProvider.html b/interfaces/_openfeature_core.CommonProvider.html index 1d8d82a29..4d34684db 100644 --- a/interfaces/_openfeature_core.CommonProvider.html +++ b/interfaces/_openfeature_core.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

Interface CommonProvider<S>

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

Type Parameters

Properties

events? +CommonProvider | Documentation

Interface CommonProvider<S>

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

Type Parameters

Properties

events? metadata runsOn? status? @@ -6,16 +6,16 @@ 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?: S

Deprecated

the SDK now maintains the provider's state; there's no need for providers to implement this field. +

Optional Readonly status

status?: S

Deprecated

the SDK now maintains the provider's state; there's no need for providers to implement this field. Returns a representation of the current readiness of the provider.

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

eventsmetadatarunsOnstatusinitializeonClose
\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

eventsmetadatarunsOnstatusinitializeonClose
\ No newline at end of file diff --git a/interfaces/_openfeature_core.EvaluationLifeCycle.html b/interfaces/_openfeature_core.EvaluationLifeCycle.html index fec277064..9f5a129d9 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

addHooksclearHooksgetHooks
\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

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

Interface Eventing<T>

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

Type Parameters

Implemented by

Methods

addHandler +Eventing | Documentation

Interface Eventing<T>

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

Type Parameters

Implemented by

Methods

addHandler getHandlers removeHandler

Methods

addHandler

getHandlers

  • getHandlers(eventType): EventHandler<T>[]

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

    +

Returns void

  • addHandler(eventType, handler): void

  • Parameters

    Returns void

  • addHandler(eventType, handler): void

  • Parameters

    Returns void

    • getHandlers

    removeHandler

    removeHandler

    • removeHandler(eventType, handler): void

    • Removes a handler for the given provider event type.

      Parameters

      • eventType: T

        The provider event type to remove the listener for

      • handler: EventHandler<T>

        The handler to remove for the provider event type

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    addHandlergetHandlersremoveHandler
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    addHandlergetHandlersremoveHandler
    \ No newline at end of file diff --git a/interfaces/_openfeature_core.HookContext.html b/interfaces/_openfeature_core.HookContext.html index 06189618f..674a3403a 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ No newline at end of file diff --git a/interfaces/_openfeature_core.Logger.html b/interfaces/_openfeature_core.Logger.html index 7ace8e62c..7e53a7229 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

    debugerrorinfowarn
    \ No newline at end of file +

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    debugerrorinfowarn
    \ No newline at end of file diff --git a/interfaces/_openfeature_core.ManageContext.html b/interfaces/_openfeature_core.ManageContext.html index 5cb62252b..3c106a52f 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

    getContextsetContext
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getContextsetContext
    \ No newline at end of file diff --git a/interfaces/_openfeature_core.ManageLogger.html b/interfaces/_openfeature_core.ManageLogger.html index f66f7fef2..d317a3703 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

    setLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    setLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_core.ProviderEventEmitter.html b/interfaces/_openfeature_core.ProviderEventEmitter.html index 822cb78c6..c23c456da 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<ServerProviderEvents | ClientProviderEvents>[];
        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<ServerProviderEvents | ClientProviderEvents>[];
        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

    addHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_core.ProviderMetadata.html b/interfaces/_openfeature_core.ProviderMetadata.html index ab3cb2eb7..7d0e7c336 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

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

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

    Hierarchy

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    name
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.BaseHook.html b/interfaces/_openfeature_server_sdk.BaseHook.html index edf417c6c..deef3670b 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

    afterbeforeerrorfinally
    \ 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

    afterbeforeerrorfinally
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.BeforeHookContext.html b/interfaces/_openfeature_server_sdk.BeforeHookContext.html index ffc6a3614..cc57094d2 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Client.html b/interfaces/_openfeature_server_sdk.Client.html index cee25e8fb..14874c0bd 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;
        providerStatus: ProviderStatus;
        addHandler(eventType, handler): void;
        addHandler(eventType, handler): void;
        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<ProviderEvents>[];
        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)

    Properties

    metadata +Client | Documentation

    Interface Client

    interface Client {
        metadata: ClientMetadata;
        providerStatus: ProviderStatus;
        addHandler(eventType, handler): void;
        addHandler(eventType, handler): void;
        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<ProviderEvents>[];
        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)

    Properties

    metadata providerStatus

    Methods

    addHandler addHooks @@ -17,86 +17,86 @@ removeHandler setContext 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

  • addHandler(eventType, handler): void

  • Parameters

    • eventType: ServerNotChangeEvents
    • handler: EventHandler<ServerNotChangeEvents>

    Returns void

  • addHandler(eventType, handler): void

  • Parameters

    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

    metadataproviderStatusaddHandleraddHooksclearHooksgetBooleanDetailsgetBooleanValuegetContextgetHandlersgetHooksgetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValueremoveHandlersetContextsetLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    metadataproviderStatusaddHandleraddHooksclearHooksgetBooleanDetailsgetBooleanValuegetContextgetHandlersgetHooksgetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValueremoveHandlersetContextsetLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ClientMetadata.html b/interfaces/_openfeature_server_sdk.ClientMetadata.html index 3116373ec..4518ea8ba 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;
    }

    Properties

    domain? +ClientMetadata | Documentation

    Interface ClientMetadata

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

    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

    domainnameproviderMetadataversion
    \ 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

    domainnameproviderMetadataversion
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.CommonProvider.html b/interfaces/_openfeature_server_sdk.CommonProvider.html index 71f91d021..6a0980a36 100644 --- a/interfaces/_openfeature_server_sdk.CommonProvider.html +++ b/interfaces/_openfeature_server_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

    Interface CommonProvider<S>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    events? +CommonProvider | Documentation

    Interface CommonProvider<S>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    events? metadata runsOn? status? @@ -6,16 +6,16 @@ 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?: S

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. +

    Optional Readonly status

    status?: S

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. Returns a representation of the current readiness of the provider.

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

    eventsmetadatarunsOnstatusinitializeonClose
    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    eventsmetadatarunsOnstatusinitializeonClose
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html index 38eee7be4..12737d508 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

    addHooksclearHooksgetHooks
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addHooksclearHooksgetHooks
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Eventing.html b/interfaces/_openfeature_server_sdk.Eventing.html index a2d7782da..582ba44c2 100644 --- a/interfaces/_openfeature_server_sdk.Eventing.html +++ b/interfaces/_openfeature_server_sdk.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation

    Interface Eventing<T>

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

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +Eventing | Documentation

    Interface Eventing<T>

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

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler getHandlers removeHandler

    Methods

    addHandler

    getHandlers

    • getHandlers(eventType): EventHandler<T>[]

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

      +

    Returns void

  • addHandler(eventType, handler): void

  • Parameters

    Returns void

  • addHandler(eventType, handler): void

  • Parameters

    Returns void

    • getHandlers

    removeHandler

    removeHandler

    • removeHandler(eventType, handler): void

    • Removes a handler for the given provider event type.

      Parameters

      • eventType: T

        The provider event type to remove the listener for

      • handler: EventHandler<T>

        The handler to remove for the provider event type

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    addHandlergetHandlersremoveHandler
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    addHandlergetHandlersremoveHandler
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Features.html b/interfaces/_openfeature_server_sdk.Features.html index 484c00b24..a8d9abf1e 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

    getBooleanDetailsgetBooleanValuegetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValue
    \ 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

    getBooleanDetailsgetBooleanValuegetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValue
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html index e9d89dc04..f0c65b2e1 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

    hookHintshooks
    \ 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

    hookHintshooks
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.HookContext.html b/interfaces/_openfeature_server_sdk.HookContext.html index 691f6e4fb..3190a6549 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Logger.html b/interfaces/_openfeature_server_sdk.Logger.html index 656a61f79..95901806d 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

    debugerrorinfowarn
    \ No newline at end of file +

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    debugerrorinfowarn
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageContext.html b/interfaces/_openfeature_server_sdk.ManageContext.html index 5d4457c8d..194bd8d27 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

    getContextsetContext
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getContextsetContext
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageLogger.html b/interfaces/_openfeature_server_sdk.ManageLogger.html index f69d5db60..e7fe0111b 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

    setLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    setLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html b/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html index 9a8f9be8b..4bb6856ff 100644 --- a/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html +++ b/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html @@ -1,10 +1,10 @@ -ManageTransactionContextPropagator | Documentation

    Interface ManageTransactionContextPropagator<T>

    interface ManageTransactionContextPropagator<T> {
        getTransactionContext(): EvaluationContext;
        setTransactionContext<TArgs, 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<TArgs, 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<TArgs, R>(transactionContext, callback, ...args): void

    • Sets the transaction context using the registered transaction context propagator. Runs the callback function, in which the transactionContext will be available by calling this#getTransactionContext.

      The TransactionContextPropagator must persist the transactionContext and make it available @@ -18,9 +18,9 @@

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

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

      Callback function to run

        • (...args): R

        • Parameters

          Returns R

    • Rest ...args: TArgs

      Optional arguments that are passed to the callback function

      -

    Returns void

    setTransactionContextPropagator

    • setTransactionContextPropagator(transactionContextPropagator): T

    • Sets a transaction context propagator on this receiver. The transaction context +

    Returns void

    setTransactionContextPropagator

    Settings

    Member Visibility

    Theme

    On This Page

    getTransactionContextsetTransactionContextsetTransactionContextPropagator
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getTransactionContextsetTransactionContextsetTransactionContextPropagator
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Provider.html b/interfaces/_openfeature_server_sdk.Provider.html index e3c2da949..ac20a7131 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,24 +14,24 @@ 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

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. +

    Optional Readonly status

    status?: ProviderStatus

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. Returns a representation of the current readiness of the provider.

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

    eventshooksmetadatarunsOnstatusinitializeonCloseresolveBooleanEvaluationresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
    \ No newline at end of file +

    Returns Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    eventshooksmetadatarunsOnstatusinitializeonCloseresolveBooleanEvaluationresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html b/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html index f3d277e63..33ffc87ef 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<ProviderEvents | ClientProviderEvents>[];
        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<ProviderEvents | ClientProviderEvents>[];
        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

    addHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ProviderMetadata.html b/interfaces/_openfeature_server_sdk.ProviderMetadata.html index 2a18904b2..ad1f0a851 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

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

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

    Hierarchy

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    name
    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html b/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html index 8770e1962..70f961d6d 100644 --- a/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html +++ b/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html @@ -1,9 +1,9 @@ -TransactionContextPropagator | Documentation

    Interface TransactionContextPropagator

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

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext +TransactionContextPropagator | Documentation

    Interface TransactionContextPropagator

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

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext setTransactionContext

    Methods

    getTransactionContext

    setTransactionContext

    setTransactionContext

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

    • Sets the transaction context using the registered transaction context propagator. Runs the callback function, in which the transactionContext will be available by calling this#getTransactionContext.

      The TransactionContextPropagator must persist the transactionContext and make it available @@ -17,4 +17,4 @@

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

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

      Callback function to run

        • (...args): R

        • Parameters

          Returns R

    • Rest ...args: TArgs

      Optional arguments that are passed to the callback function

      -

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    getTransactionContextsetTransactionContext
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    getTransactionContextsetTransactionContext
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.BaseHook.html b/interfaces/_openfeature_web_sdk.BaseHook.html index ece7c7e25..242052d42 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

    afterbeforeerrorfinally
    \ 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

    afterbeforeerrorfinally
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.BeforeHookContext.html b/interfaces/_openfeature_web_sdk.BeforeHookContext.html index 003c77121..b2dd0a7ca 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Client.html b/interfaces/_openfeature_web_sdk.Client.html index 88b120c20..ed4f6fcc3 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;
        addHandler(eventType, handler): void;
        addHandler(eventType, handler): void;
        addHooks(...hooks): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>;
        getBooleanValue(flagKey, defaultValue, options?): boolean;
        getHandlers(eventType): EventHandler<ProviderEvents>[];
        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)

    Properties

    metadata +Client | Documentation

    Interface Client

    interface Client {
        metadata: ClientMetadata;
        providerStatus: ProviderStatus;
        addHandler(eventType, handler): void;
        addHandler(eventType, handler): void;
        addHandler(eventType, handler): void;
        addHooks(...hooks): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>;
        getBooleanValue(flagKey, defaultValue, options?): boolean;
        getHandlers(eventType): EventHandler<ProviderEvents>[];
        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)

    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

  • addHandler(eventType, handler): void

  • Parameters

    • eventType: ClientNotChangeEvents
    • handler: EventHandler<ClientNotChangeEvents>

    Returns void

  • addHandler(eventType, handler): void

  • Parameters

    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

    metadataproviderStatusaddHandleraddHooksclearHooksgetBooleanDetailsgetBooleanValuegetHandlersgetHooksgetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValueremoveHandlersetLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    metadataproviderStatusaddHandleraddHooksclearHooksgetBooleanDetailsgetBooleanValuegetHandlersgetHooksgetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValueremoveHandlersetLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ClientMetadata.html b/interfaces/_openfeature_web_sdk.ClientMetadata.html index 19c52bb7a..044f9be27 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;
    }

    Properties

    domain? +ClientMetadata | Documentation

    Interface ClientMetadata

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

    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

    domainnameproviderMetadataversion
    \ 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

    domainnameproviderMetadataversion
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.CommonProvider.html b/interfaces/_openfeature_web_sdk.CommonProvider.html index 03459a741..adae6e51c 100644 --- a/interfaces/_openfeature_web_sdk.CommonProvider.html +++ b/interfaces/_openfeature_web_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

    Interface CommonProvider<S>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    events? +CommonProvider | Documentation

    Interface CommonProvider<S>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    events? metadata runsOn? status? @@ -6,16 +6,16 @@ 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?: S

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. +

    Optional Readonly status

    status?: S

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. Returns a representation of the current readiness of the provider.

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

    eventsmetadatarunsOnstatusinitializeonClose
    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    eventsmetadatarunsOnstatusinitializeonClose
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html index 2b4907659..ae7ab81f0 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

    addHooksclearHooksgetHooks
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addHooksclearHooksgetHooks
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Eventing.html b/interfaces/_openfeature_web_sdk.Eventing.html index 999e3101e..fb476a190 100644 --- a/interfaces/_openfeature_web_sdk.Eventing.html +++ b/interfaces/_openfeature_web_sdk.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation

    Interface Eventing<T>

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

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +Eventing | Documentation

    Interface Eventing<T>

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

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler getHandlers removeHandler

    Methods

    addHandler

    getHandlers

    • getHandlers(eventType): EventHandler<T>[]

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

      +

    Returns void

  • addHandler(eventType, handler): void

  • Parameters

    • eventType: T extends ProviderEvents
          ? ClientNotChangeEvents
          : ServerNotChangeEvents
    • handler: EventHandler<T extends ProviderEvents
          ? ClientNotChangeEvents
          : ServerNotChangeEvents>

    Returns void

  • addHandler(eventType, handler): void

  • Parameters

    Returns void

    • getHandlers

    removeHandler

    removeHandler

    • removeHandler(eventType, handler): void

    • Removes a handler for the given provider event type.

      Parameters

      • eventType: T

        The provider event type to remove the listener for

      • handler: EventHandler<T>

        The handler to remove for the provider event type

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    addHandlergetHandlersremoveHandler
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    addHandlergetHandlersremoveHandler
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Features.html b/interfaces/_openfeature_web_sdk.Features.html index 6cf064ecf..754ee0e43 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

    getBooleanDetailsgetBooleanValuegetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValue
    \ 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

    getBooleanDetailsgetBooleanValuegetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValue
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html index db699672a..e30d27c51 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

    hookHintshooks
    \ 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

    hookHintshooks
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.HookContext.html b/interfaces/_openfeature_web_sdk.HookContext.html index cd9663583..ecf5cca52 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ 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

    clientMetadatacontextdefaultValueflagKeyflagValueTypeloggerproviderMetadata
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Logger.html b/interfaces/_openfeature_web_sdk.Logger.html index 67b8c5441..643814aca 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

    debugerrorinfowarn
    \ No newline at end of file +

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    debugerrorinfowarn
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ManageContext.html b/interfaces/_openfeature_web_sdk.ManageContext.html index 3068a8b22..f6145174a 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

    getContextsetContext
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    getContextsetContext
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ManageLogger.html b/interfaces/_openfeature_web_sdk.ManageLogger.html index a6f892762..c2e391625 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

    setLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    setLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Provider.html b/interfaces/_openfeature_web_sdk.Provider.html index bdb1b0b00..88f682816 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): void | 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): void | 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,30 +15,30 @@ 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

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. +

    Optional Readonly status

    status?: ProviderStatus

    Deprecated

    the SDK now maintains the provider's state; there's no need for providers to implement this field. Returns a representation of the current readiness of the provider.

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

    • onContextChange(oldContext, newContext): void | Promise<void>

    • A handler function to reconcile changes made to the static context. Called by the SDK when the context is changed.

      Returning a promise will put the provider in the RECONCILING state and emit the ProviderEvents.Reconciling event.

      Return void will avoid putting the provider in the RECONCILING state and not emit the ProviderEvents.Reconciling event.

      -

      Parameters

      Returns void | Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    eventshooksmetadatarunsOnstatusinitializeonCloseonContextChangeresolveBooleanEvaluationresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
    \ No newline at end of file +

    Parameters

    Returns void | Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    eventshooksmetadatarunsOnstatusinitializeonCloseonContextChangeresolveBooleanEvaluationresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html b/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html index 3bfab50db..c75777c94 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<ServerProviderEvents | ProviderEvents>[];
        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<ServerProviderEvents | ProviderEvents>[];
        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

    addHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addHandleremitgetHandlersremoveAllHandlersremoveHandlersetLogger
    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ProviderMetadata.html b/interfaces/_openfeature_web_sdk.ProviderMetadata.html index 335dbf991..5b64540a2 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

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

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

    Hierarchy

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    name
    \ No newline at end of file diff --git a/types/_openfeature_core.AnyProviderEvent.html b/types/_openfeature_core.AnyProviderEvent.html index 84f0a759f..272aaebb7 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). In most cases, you probably want to import ProviderEvents from the respective SDK.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.CommonEventDetails.html b/types/_openfeature_core.CommonEventDetails.html index 5ba475d3a..795419b9a 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 Readonly clientName?: string

      Deprecated

      alias of "domain", use domain instead

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

    Settings

    Member Visibility

    Theme

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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.ConfigChangeEvent.html b/types/_openfeature_core.ConfigChangeEvent.html index 364d2d6bd..036a14559 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 Readonly flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional Readonly flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.ErrorEvent.html b/types/_openfeature_core.ErrorEvent.html index 919244d01..b3d177d52 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

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.EvaluationContextValue.html b/types/_openfeature_core.EvaluationContextValue.html index 2138cd456..48276134d 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

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.EvaluationDetails.html b/types/_openfeature_core.EvaluationDetails.html index c1a11cfea..b0d0870ee 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_core.EventContext.html b/types/_openfeature_core.EventContext.html index 99fb5f26e..2abb0bbef 100644 --- a/types/_openfeature_core.EventContext.html +++ b/types/_openfeature_core.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<U, T>

    EventContext<U, T>: (T extends ClientProviderEvents
        ? ClientEventMap[T]
        : T extends ServerProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U, T>

    EventContext<U, T>: (T extends ClientProviderEvents
        ? ClientEventMap[T]
        : T extends ServerProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

    Settings

    Member Visibility

    Theme

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

    Type alias EventDetails<T>

    EventDetails<T>: EventContext<Record<string, unknown>, T> & CommonEventDetails

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails<T>

    EventDetails<T>: EventContext<Record<string, unknown>, T> & CommonEventDetails

    Type Parameters

    Settings

    Member Visibility

    Theme

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

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.EventMetadata.html b/types/_openfeature_core.EventMetadata.html index 6729dd57a..c23516787 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_core.FlagMetadata.html b/types/_openfeature_core.FlagMetadata.html index 5c68fc39d..b285a53b4 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.FlagValue.html b/types/_openfeature_core.FlagValue.html index e6a30dfdf..72d122343 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.FlagValueType.html b/types/_openfeature_core.FlagValueType.html index d0a55195c..f90bf35ff 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

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.HookHints.html b/types/_openfeature_core.HookHints.html index eecd0885f..2beb42ae0 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

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.JsonArray.html b/types/_openfeature_core.JsonArray.html index 8b1816e0e..e5b72b0e0 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

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.JsonObject.html b/types/_openfeature_core.JsonObject.html index 4209ec86b..ed5f75d5f 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

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.JsonValue.html b/types/_openfeature_core.JsonValue.html index 7ed1f4e36..07e91c3dd 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

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

    Type alias Metadata

    Metadata: Record<string, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Metadata | Documentation

    Type alias Metadata

    Metadata: Record<string, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.NotChangeEvents.html b/types/_openfeature_core.NotChangeEvents.html index 4a4fe15be..868af3a24 100644 --- a/types/_openfeature_core.NotChangeEvents.html +++ b/types/_openfeature_core.NotChangeEvents.html @@ -1 +1 @@ -NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.Paradigm.html b/types/_openfeature_core.Paradigm.html index 18670fa5e..d9de1fcdc 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.PrimitiveValue.html b/types/_openfeature_core.PrimitiveValue.html index f3d2af4b9..d7525c60c 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

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.ReadyEvent.html b/types/_openfeature_core.ReadyEvent.html index 9ae71ca82..c99ce389f 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

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.ReconcilingEvent.html b/types/_openfeature_core.ReconcilingEvent.html index d8eae0239..9708970aa 100644 --- a/types/_openfeature_core.ReconcilingEvent.html +++ b/types/_openfeature_core.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.ResolutionDetails.html b/types/_openfeature_core.ResolutionDetails.html index 72e4bac7b..85204b6c4 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_core.ResolutionReason.html b/types/_openfeature_core.ResolutionReason.html index 8cc505fe8..c8103ec79 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

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_core.StaleEvent.html b/types/_openfeature_core.StaleEvent.html index 6ec98cbb3..8922e2cbd 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

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.AnyProviderEvent.html b/types/_openfeature_server_sdk.AnyProviderEvent.html index de3392251..15225d3b9 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). In most cases, you probably want to import ProviderEvents from the respective SDK.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.CommonEventDetails.html b/types/_openfeature_server_sdk.CommonEventDetails.html index f746560e1..2a4da474f 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 Readonly clientName?: string

      Deprecated

      alias of "domain", use domain instead

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

    Settings

    Member Visibility

    Theme

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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ConfigChangeEvent.html b/types/_openfeature_server_sdk.ConfigChangeEvent.html index 2456aa93f..c830b7202 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 Readonly flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional Readonly flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ErrorEvent.html b/types/_openfeature_server_sdk.ErrorEvent.html index d517b7f6a..e56369570 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

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationContext.html b/types/_openfeature_server_sdk.EvaluationContext.html index 8eff6f1cd..e66bf3234 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationContextValue.html b/types/_openfeature_server_sdk.EvaluationContextValue.html index 2b2dc881f..07ab0b3c1 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

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationDetails.html b/types/_openfeature_server_sdk.EvaluationDetails.html index 19fd891be..f44b266dc 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventContext.html b/types/_openfeature_server_sdk.EventContext.html index 4051684e3..be948f27a 100644 --- a/types/_openfeature_server_sdk.EventContext.html +++ b/types/_openfeature_server_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<U, T>

    EventContext<U, T>: (T extends ClientProviderEvents
        ? ClientEventMap[T]
        : T extends ProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U, T>

    EventContext<U, T>: (T extends ClientProviderEvents
        ? ClientEventMap[T]
        : T extends ProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

    Settings

    Member Visibility

    Theme

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

    Type alias EventDetails<T>

    EventDetails<T>: EventContext<Record<string, unknown>, T> & CommonEventDetails

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails<T>

    EventDetails<T>: EventContext<Record<string, unknown>, T> & CommonEventDetails

    Type Parameters

    Settings

    Member Visibility

    Theme

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

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventMetadata.html b/types/_openfeature_server_sdk.EventMetadata.html index 090f3ed28..bceb5f8bf 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagMetadata.html b/types/_openfeature_server_sdk.FlagMetadata.html index d2455ef8b..d68d08696 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagValue.html b/types/_openfeature_server_sdk.FlagValue.html index 83c117494..2b3fc4be3 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagValueType.html b/types/_openfeature_server_sdk.FlagValueType.html index 41a70fcba..8cd533bc4 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

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.Hook.html b/types/_openfeature_server_sdk.Hook.html index 08b64cab7..23bb3dfd1 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.HookHints.html b/types/_openfeature_server_sdk.HookHints.html index 7b25d557e..2a78e4d6e 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

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.JsonArray.html b/types/_openfeature_server_sdk.JsonArray.html index 6fcf3f953..665d74017 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

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.JsonObject.html b/types/_openfeature_server_sdk.JsonObject.html index 1d57a7115..5cb02fa28 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

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.JsonValue.html b/types/_openfeature_server_sdk.JsonValue.html index 429268977..d4ee323b9 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.Metadata.html b/types/_openfeature_server_sdk.Metadata.html index 730a3fb7b..ce8513bb5 100644 --- a/types/_openfeature_server_sdk.Metadata.html +++ b/types/_openfeature_server_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

    Type alias Metadata

    Metadata: Record<string, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Metadata | Documentation

    Type alias Metadata

    Metadata: Record<string, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.NotChangeEvents.html b/types/_openfeature_server_sdk.NotChangeEvents.html index 4315fa2ed..c33e632a9 100644 --- a/types/_openfeature_server_sdk.NotChangeEvents.html +++ b/types/_openfeature_server_sdk.NotChangeEvents.html @@ -1 +1 @@ -NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.Paradigm.html b/types/_openfeature_server_sdk.Paradigm.html index da099567e..df9918180 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.PrimitiveValue.html b/types/_openfeature_server_sdk.PrimitiveValue.html index a243210c6..beeb3a9e3 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

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ReadyEvent.html b/types/_openfeature_server_sdk.ReadyEvent.html index e79a74588..3589298b4 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

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ReconcilingEvent.html b/types/_openfeature_server_sdk.ReconcilingEvent.html index 23e4fa46f..98731ac54 100644 --- a/types/_openfeature_server_sdk.ReconcilingEvent.html +++ b/types/_openfeature_server_sdk.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ResolutionDetails.html b/types/_openfeature_server_sdk.ResolutionDetails.html index 3899d49e3..4d5b997c9 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ResolutionReason.html b/types/_openfeature_server_sdk.ResolutionReason.html index 6397795f2..6e9158fc1 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

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.StaleEvent.html b/types/_openfeature_server_sdk.StaleEvent.html index 2d29ffecf..260830bda 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

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.TransactionContext.html b/types/_openfeature_server_sdk.TransactionContext.html index a291a5d08..7c84e36fb 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.AnyProviderEvent.html b/types/_openfeature_web_sdk.AnyProviderEvent.html index eb9ec7ee6..93aad31f8 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). In most cases, you probably want to import ProviderEvents from the respective SDK.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.CommonEventDetails.html b/types/_openfeature_web_sdk.CommonEventDetails.html index 481e9e7a2..14e03c41d 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 Readonly clientName?: string

      Deprecated

      alias of "domain", use domain instead

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

    Settings

    Member Visibility

    Theme

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

    • Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ConfigChangeEvent.html b/types/_openfeature_web_sdk.ConfigChangeEvent.html index a42ffd35b..b2666eb04 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 Readonly flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional Readonly flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ErrorEvent.html b/types/_openfeature_web_sdk.ErrorEvent.html index b5c0c540e..1d306141e 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

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationContext.html b/types/_openfeature_web_sdk.EvaluationContext.html index e9d3f0ca5..240d9acc0 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationContextValue.html b/types/_openfeature_web_sdk.EvaluationContextValue.html index 90273cc3a..d86a417c1 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

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationDetails.html b/types/_openfeature_web_sdk.EvaluationDetails.html index 785ad1d41..76b460522 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventContext.html b/types/_openfeature_web_sdk.EventContext.html index dd09b7f3b..94728dc15 100644 --- a/types/_openfeature_web_sdk.EventContext.html +++ b/types/_openfeature_web_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<U, T>

    EventContext<U, T>: (T extends ProviderEvents
        ? ClientEventMap[T]
        : T extends ServerProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U, T>

    EventContext<U, T>: (T extends ProviderEvents
        ? ClientEventMap[T]
        : T extends ServerProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventDetails.html b/types/_openfeature_web_sdk.EventDetails.html index 285bd8ca0..25a980364 100644 --- a/types/_openfeature_web_sdk.EventDetails.html +++ b/types/_openfeature_web_sdk.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation

    Type alias EventDetails<T>

    EventDetails<T>: EventContext<Record<string, unknown>, T> & CommonEventDetails

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails<T>

    EventDetails<T>: EventContext<Record<string, unknown>, T> & CommonEventDetails

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventHandler.html b/types/_openfeature_web_sdk.EventHandler.html index 06e89a261..2ddd410ae 100644 --- a/types/_openfeature_web_sdk.EventHandler.html +++ b/types/_openfeature_web_sdk.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventMetadata.html b/types/_openfeature_web_sdk.EventMetadata.html index 0d88acb6b..2d98469cb 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagMetadata.html b/types/_openfeature_web_sdk.FlagMetadata.html index 408b4453f..29df73a06 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagValue.html b/types/_openfeature_web_sdk.FlagValue.html index e1d379ad4..04c194be3 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagValueType.html b/types/_openfeature_web_sdk.FlagValueType.html index b29c7d7ac..93c6e7ee8 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

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Hook.html b/types/_openfeature_web_sdk.Hook.html index 84243aeb3..7b389a7fe 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

    \ No newline at end of file +Hook | Documentation

    Type alias Hook

    Hook: BaseHook<FlagValue, void, void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.HookHints.html b/types/_openfeature_web_sdk.HookHints.html index 9bf939fbd..d6b532367 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

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonArray.html b/types/_openfeature_web_sdk.JsonArray.html index b769d5d08..25db17cd3 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

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonObject.html b/types/_openfeature_web_sdk.JsonObject.html index df1fec1b8..b4c60eb14 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

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonValue.html b/types/_openfeature_web_sdk.JsonValue.html index cd43ece7e..f8820f0bf 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Metadata.html b/types/_openfeature_web_sdk.Metadata.html index 6faa31275..4195fe8ba 100644 --- a/types/_openfeature_web_sdk.Metadata.html +++ b/types/_openfeature_web_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

    Type alias Metadata

    Metadata: Record<string, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Metadata | Documentation

    Type alias Metadata

    Metadata: Record<string, string>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.NotChangeEvents.html b/types/_openfeature_web_sdk.NotChangeEvents.html index e5d912e24..65265f407 100644 --- a/types/_openfeature_web_sdk.NotChangeEvents.html +++ b/types/_openfeature_web_sdk.NotChangeEvents.html @@ -1 +1 @@ -NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Paradigm.html b/types/_openfeature_web_sdk.Paradigm.html index ca941e8d9..7c8437c86 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.PrimitiveValue.html b/types/_openfeature_web_sdk.PrimitiveValue.html index abb4e53fd..456ec9e33 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

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ProviderEmittableEvents.html b/types/_openfeature_web_sdk.ProviderEmittableEvents.html index 9e75f6f01..d6d9046a4 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ReadyEvent.html b/types/_openfeature_web_sdk.ReadyEvent.html index 00841bd4c..eeb3186bd 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

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ReconcilingEvent.html b/types/_openfeature_web_sdk.ReconcilingEvent.html index 682aca561..32ce71287 100644 --- a/types/_openfeature_web_sdk.ReconcilingEvent.html +++ b/types/_openfeature_web_sdk.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ResolutionDetails.html b/types/_openfeature_web_sdk.ResolutionDetails.html index 0c007f7a3..44ff0e46b 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

    \ 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

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ResolutionReason.html b/types/_openfeature_web_sdk.ResolutionReason.html index 885292c34..fce700164 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

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.StaleEvent.html b/types/_openfeature_web_sdk.StaleEvent.html index 3967ff7e9..fccf423b0 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

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/_openfeature_core.LOG_LEVELS.html b/variables/_openfeature_core.LOG_LEVELS.html index d3b27e9d7..615861160 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

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/_openfeature_core.StandardResolutionReasons.html b/variables/_openfeature_core.StandardResolutionReasons.html index 15db84c83..8c2f73925 100644 --- a/variables/_openfeature_core.StandardResolutionReasons.html +++ b/variables/_openfeature_core.StandardResolutionReasons.html @@ -8,4 +8,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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 af50149ea..a54fb4c3d 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

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    \ 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 681b98979..e80190143 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

    \ No newline at end of file +NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    \ 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 59bd781a9..ceaa904d5 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

    \ 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

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.OpenFeature.html b/variables/_openfeature_server_sdk.OpenFeature.html index 727128233..61c64db83 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.StandardResolutionReasons.html b/variables/_openfeature_server_sdk.StandardResolutionReasons.html index 3ec975fc8..dffcc4595 100644 --- a/variables/_openfeature_server_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_server_sdk.StandardResolutionReasons.html @@ -8,4 +8,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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ 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 276d2fff6..1c89ebf25 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

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

    LOG_LEVELS: (keyof Logger)[] = ...

    Settings

    Member Visibility

    Theme

    \ 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 47a1614b6..9a3d79bfd 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

    \ No newline at end of file +NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.OpenFeature.html b/variables/_openfeature_web_sdk.OpenFeature.html index 6b70829ca..b33c29c26 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.StandardResolutionReasons.html b/variables/_openfeature_web_sdk.StandardResolutionReasons.html index 64cba7907..ae3c5ad63 100644 --- a/variables/_openfeature_web_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_web_sdk.StandardResolutionReasons.html @@ -8,4 +8,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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file