From d6b6eaf83b3e571786a4241de1b2d255696f9786 Mon Sep 17 00:00:00 2001 From: toddbaert Date: Wed, 4 Dec 2024 18:38:34 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=203c9f2?= =?UTF-8?q?c6e3659805c5e941b213234ec9fdcf37372=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 | 6 +- ..._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 | 14 ++--- ..._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 | 42 +++++++------- ...openfeature_server_sdk.ClientMetadata.html | 6 +- ...openfeature_server_sdk.CommonProvider.html | 14 ++--- ...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 | 24 ++++---- ...ature_server_sdk.ProviderEventEmitter.html | 6 +- ...enfeature_server_sdk.ProviderMetadata.html | 4 +- .../_openfeature_server_sdk.Tracking.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 | 38 ++++++------ .../_openfeature_web_sdk.ClientMetadata.html | 6 +- .../_openfeature_web_sdk.CommonProvider.html | 14 ++--- ...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 | 26 ++++----- ...nfeature_web_sdk.ProviderEventEmitter.html | 6 +- ..._openfeature_web_sdk.ProviderMetadata.html | 4 +- interfaces/_openfeature_web_sdk.Tracking.html | 4 +- media/README-3.md | 11 ++-- 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 +- ...openfeature_core.TrackingEventDetails.html | 2 +- .../_openfeature_core.TrackingEventValue.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 +- ...ature_server_sdk.TrackingEventDetails.html | 2 +- ...feature_server_sdk.TrackingEventValue.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 +- ...nfeature_web_sdk.TrackingEventDetails.html | 2 +- ...penfeature_web_sdk.TrackingEventValue.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 +- 233 files changed, 642 insertions(+), 639 deletions(-) diff --git a/classes/_openfeature_core.DefaultLogger.html b/classes/_openfeature_core.DefaultLogger.html index 1cbe0fda2..a5e09921e 100644 --- a/classes/_openfeature_core.DefaultLogger.html +++ b/classes/_openfeature_core.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Implements

Constructors

constructor +DefaultLogger | Documentation

Implements

Constructors

Methods

Constructors

Methods

+

Constructors

Methods

diff --git a/classes/_openfeature_core.FlagNotFoundError.html b/classes/_openfeature_core.FlagNotFoundError.html index 20aa44f61..ff947655a 100644 --- a/classes/_openfeature_core.FlagNotFoundError.html +++ b/classes/_openfeature_core.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_core.GeneralError.html b/classes/_openfeature_core.GeneralError.html index 3e357a621..f5c7fac0f 100644 --- a/classes/_openfeature_core.GeneralError.html +++ b/classes/_openfeature_core.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_core.GenericEventEmitter.html b/classes/_openfeature_core.GenericEventEmitter.html index 74928ec9b..ff13888de 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

Type Parameters

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

Implements

Constructors

Properties

Accessors

Methods

Constructors

Properties

eventEmitter: PlatformEventEmitter

Accessors

Methods

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

Constructors

Properties

eventEmitter: PlatformEventEmitter

Accessors

Methods

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

    -
+
diff --git a/classes/_openfeature_core.InvalidContextError.html b/classes/_openfeature_core.InvalidContextError.html index d55106dfa..2161b8b6d 100644 --- a/classes/_openfeature_core.InvalidContextError.html +++ b/classes/_openfeature_core.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_core.OpenFeatureCommonAPI.html b/classes/_openfeature_core.OpenFeatureCommonAPI.html index eadcdd7a6..96536746d 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

Properties

_apiEmitter: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<P, AnyProviderStatus>
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>
_hooks: H[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ClientProviderStatus | typeof ServerProviderStatus

Accessors

  • get providerMetadata(): ProviderMetadata
  • Get metadata about the default provider.

    +

Constructors

Properties

_apiEmitter: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<P, AnyProviderStatus>
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>
_hooks: H[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ClientProviderStatus | typeof ServerProviderStatus

Accessors

Methods

Methods

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

Returns void

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

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

    Parameters

    • Optionaldomain: string

      An identifier which logically binds clients with providers

    Returns ProviderMetadata

    Provider Metadata

    -
  • Parameters

    • OptionaldomainOrProvider: string | P
    • OptionalproviderOrUndefined: P

    Returns void | Promise<void>

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

Returns void

+
diff --git a/classes/_openfeature_core.OpenFeatureError.html b/classes/_openfeature_core.OpenFeatureError.html index e05e28828..1be1889ef 100644 --- a/classes/_openfeature_core.OpenFeatureError.html +++ b/classes/_openfeature_core.OpenFeatureError.html @@ -1,4 +1,4 @@ -OpenFeatureError | Documentation

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_core.ParseError.html b/classes/_openfeature_core.ParseError.html index 2d15b3a6f..c00a523db 100644 --- a/classes/_openfeature_core.ParseError.html +++ b/classes/_openfeature_core.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_core.ProviderFatalError.html b/classes/_openfeature_core.ProviderFatalError.html index 8931adfc9..0ad50b952 100644 --- a/classes/_openfeature_core.ProviderFatalError.html +++ b/classes/_openfeature_core.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

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

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_core.ProviderWrapper.html b/classes/_openfeature_core.ProviderWrapper.html index 4e6706dd4..ca1b2b673 100644 --- a/classes/_openfeature_core.ProviderWrapper.html +++ b/classes/_openfeature_core.ProviderWrapper.html @@ -1,9 +1,9 @@ ProviderWrapper | Documentation

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

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

Accessors

Methods

+

Constructors

Accessors

Methods

diff --git a/classes/_openfeature_core.SafeLogger.html b/classes/_openfeature_core.SafeLogger.html index 603f5d276..f63bce9a6 100644 --- a/classes/_openfeature_core.SafeLogger.html +++ b/classes/_openfeature_core.SafeLogger.html @@ -1,6 +1,6 @@ -SafeLogger | Documentation

Implements

Constructors

constructor +SafeLogger | Documentation

Implements

Constructors

Methods

Constructors

Methods

+

Constructors

Methods

diff --git a/classes/_openfeature_core.TargetingKeyMissingError.html b/classes/_openfeature_core.TargetingKeyMissingError.html index ef73ed7d7..df37eca9c 100644 --- a/classes/_openfeature_core.TargetingKeyMissingError.html +++ b/classes/_openfeature_core.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_core.TypeMismatchError.html b/classes/_openfeature_core.TypeMismatchError.html index 82bb98164..075566a6c 100644 --- a/classes/_openfeature_core.TypeMismatchError.html +++ b/classes/_openfeature_core.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html b/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html index 6e6582ef2..d9fc4577e 100644 --- a/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html +++ b/classes/_openfeature_server_sdk.AsyncLocalStorageTransactionContextPropagator.html @@ -1,10 +1,10 @@ -AsyncLocalStorageTransactionContextPropagator | Documentation

Implements

Constructors

constructor +AsyncLocalStorageTransactionContextPropagator | Documentation

Implements

Constructors

Methods

  • 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: TArgs) => R)

    Callback function to run

      • (...args): R
      • Parameters

        Returns R

  • Rest...args: TArgs

    Optional arguments that are passed to the callback function

    -

Returns void

+

Returns void

diff --git a/classes/_openfeature_server_sdk.DefaultLogger.html b/classes/_openfeature_server_sdk.DefaultLogger.html index 27653d6c2..406b509f8 100644 --- a/classes/_openfeature_server_sdk.DefaultLogger.html +++ b/classes/_openfeature_server_sdk.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Implements

Constructors

constructor +DefaultLogger | Documentation

Implements

Constructors

Methods

Constructors

Methods

+

Constructors

Methods

diff --git a/classes/_openfeature_server_sdk.FlagNotFoundError.html b/classes/_openfeature_server_sdk.FlagNotFoundError.html index 43f991e8d..b5520786c 100644 --- a/classes/_openfeature_server_sdk.FlagNotFoundError.html +++ b/classes/_openfeature_server_sdk.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

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

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.GenericEventEmitter.html b/classes/_openfeature_server_sdk.GenericEventEmitter.html index 37be69b04..72bb00fb0 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

Type Parameters

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

Hierarchy (view full)

Implements

Constructors

Properties

Accessors

Methods

Constructors

Properties

eventEmitter: PlatformEventEmitter

Accessors

Methods

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

Constructors

Properties

eventEmitter: PlatformEventEmitter

Accessors

Methods

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

    -
+
diff --git a/classes/_openfeature_server_sdk.InMemoryProvider.html b/classes/_openfeature_server_sdk.InMemoryProvider.html index a361a6b8a..fd0b0ca26 100644 --- a/classes/_openfeature_server_sdk.InMemoryProvider.html +++ b/classes/_openfeature_server_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

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

-

Implements

Constructors

Implements

Constructors

Properties

An event emitter for ProviderEvents.

+

Constructors

Properties

An event emitter for ProviderEvents.

ProviderEvents

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

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

metadata: {
    name: "in-memory";
} = ...
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

Methods

+

Returns void

diff --git a/classes/_openfeature_server_sdk.InvalidContextError.html b/classes/_openfeature_server_sdk.InvalidContextError.html index bb88149b8..6877cd76b 100644 --- a/classes/_openfeature_server_sdk.InvalidContextError.html +++ b/classes/_openfeature_server_sdk.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.OpenFeatureAPI.html b/classes/_openfeature_server_sdk.OpenFeatureAPI.html index 4a34f331e..38c7b734a 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureAPI.html +++ b/classes/_openfeature_server_sdk.OpenFeatureAPI.html @@ -1,4 +1,4 @@ -OpenFeatureAPI | Documentation

Hierarchy (view full)

Implements

Properties

_apiEmitter +OpenFeatureAPI | Documentation

Hierarchy (view full)

Implements

Properties

_apiEmitter: OpenFeatureEventEmitter = ...
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<Provider, ProviderStatus>> = ...
_hooks: Hook[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

  • get providerMetadata(): ProviderMetadata
  • Get metadata about the default provider.

    +

Properties

_apiEmitter: OpenFeatureEventEmitter = ...
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<Provider, ProviderStatus>> = ...
_hooks: Hook[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

Methods

Methods

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

Returns void

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

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

    • Optionalcontext: EvaluationContext

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

    Returns Client

    OpenFeature Client

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

  • A factory function for creating new domain scoped OpenFeature clients. Clients can contain their own state (e.g. logger, hook, context). Multiple clients can be used to segment feature flag configuration.

    If there is already a provider bound to this domain via this.setProvider setProvider, this provider will be used. @@ -66,7 +66,7 @@

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

    • Optionalcontext: EvaluationContext

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

    Returns Client

    OpenFeature Client

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

  • A factory function for creating new domain scoped OpenFeature clients. Clients can contain their own state (e.g. logger, hook, context). Multiple clients can be used to segment feature flag configuration.

    If there is already a provider bound to this domain via this.setProvider setProvider, this provider will be used. @@ -75,55 +75,55 @@

  • version: string

    The version of the client (only used for metadata)

  • Optionalcontext: EvaluationContext

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

Returns Client

OpenFeature Client

-

Returns void

Parameters

Returns void

Returns void

+
diff --git a/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html b/classes/_openfeature_server_sdk.OpenFeatureCommonAPI.html index 23a57b750..9c32403f8 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

Properties

_apiEmitter: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<P, AnyProviderStatus>
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>
_hooks: H[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ClientProviderStatus | typeof ProviderStatus

Accessors

  • get providerMetadata(): ProviderMetadata
  • Get metadata about the default provider.

    +

Constructors

Properties

_apiEmitter: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<P, AnyProviderStatus>
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>
_hooks: H[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ClientProviderStatus | typeof ProviderStatus

Accessors

Methods

Methods

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

Returns void

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

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

    Parameters

    • Optionaldomain: string

      An identifier which logically binds clients with providers

    Returns ProviderMetadata

    Provider Metadata

    -
  • Parameters

    • OptionaldomainOrProvider: string | P
    • OptionalproviderOrUndefined: P

    Returns void | Promise<void>

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

Returns void

+
diff --git a/classes/_openfeature_server_sdk.OpenFeatureError.html b/classes/_openfeature_server_sdk.OpenFeatureError.html index b71ddf3e8..22b9bc824 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureError.html +++ b/classes/_openfeature_server_sdk.OpenFeatureError.html @@ -1,4 +1,4 @@ -OpenFeatureError | Documentation

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html index f2be2007f..9b2789dfd 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

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

Properties

eventEmitter: EventEmitter<DefaultEventMap> = ...

Accessors

Methods

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

Constructors

Properties

eventEmitter: EventEmitter<DefaultEventMap> = ...

Accessors

Methods

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

    -
+
diff --git a/classes/_openfeature_server_sdk.ParseError.html b/classes/_openfeature_server_sdk.ParseError.html index c6ddd3010..6d72d792e 100644 --- a/classes/_openfeature_server_sdk.ParseError.html +++ b/classes/_openfeature_server_sdk.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.ProviderFatalError.html b/classes/_openfeature_server_sdk.ProviderFatalError.html index a10238dcc..dc8fd7289 100644 --- a/classes/_openfeature_server_sdk.ProviderFatalError.html +++ b/classes/_openfeature_server_sdk.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.ProviderNotReadyError.html b/classes/_openfeature_server_sdk.ProviderNotReadyError.html index 0fdd4663b..1429bec5c 100644 --- a/classes/_openfeature_server_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_server_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.ProviderWrapper.html b/classes/_openfeature_server_sdk.ProviderWrapper.html index f93d373e1..091ca521c 100644 --- a/classes/_openfeature_server_sdk.ProviderWrapper.html +++ b/classes/_openfeature_server_sdk.ProviderWrapper.html @@ -1,9 +1,9 @@ ProviderWrapper | Documentation

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

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

Accessors

Methods

+

Constructors

Accessors

Methods

diff --git a/classes/_openfeature_server_sdk.SafeLogger.html b/classes/_openfeature_server_sdk.SafeLogger.html index 05c59c7db..9dea0c58f 100644 --- a/classes/_openfeature_server_sdk.SafeLogger.html +++ b/classes/_openfeature_server_sdk.SafeLogger.html @@ -1,6 +1,6 @@ -SafeLogger | Documentation

Implements

Constructors

constructor +SafeLogger | Documentation

Implements

Constructors

Methods

Constructors

Methods

+

Constructors

Methods

diff --git a/classes/_openfeature_server_sdk.TargetingKeyMissingError.html b/classes/_openfeature_server_sdk.TargetingKeyMissingError.html index 9e7545ad0..24769ae7d 100644 --- a/classes/_openfeature_server_sdk.TargetingKeyMissingError.html +++ b/classes/_openfeature_server_sdk.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_server_sdk.TypeMismatchError.html b/classes/_openfeature_server_sdk.TypeMismatchError.html index 28e95ca8f..8c300efb9 100644 --- a/classes/_openfeature_server_sdk.TypeMismatchError.html +++ b/classes/_openfeature_server_sdk.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.DefaultLogger.html b/classes/_openfeature_web_sdk.DefaultLogger.html index 6dfba15f2..04ba9d111 100644 --- a/classes/_openfeature_web_sdk.DefaultLogger.html +++ b/classes/_openfeature_web_sdk.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Implements

Constructors

constructor +DefaultLogger | Documentation

Implements

Constructors

Methods

Constructors

Methods

+

Constructors

Methods

diff --git a/classes/_openfeature_web_sdk.FlagNotFoundError.html b/classes/_openfeature_web_sdk.FlagNotFoundError.html index fdc2d8a56..44a5c4d95 100644 --- a/classes/_openfeature_web_sdk.FlagNotFoundError.html +++ b/classes/_openfeature_web_sdk.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

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

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.GenericEventEmitter.html b/classes/_openfeature_web_sdk.GenericEventEmitter.html index e70862c40..6de6df4d4 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

Type Parameters

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

Hierarchy (view full)

Implements

Constructors

Properties

Accessors

Methods

Constructors

Properties

eventEmitter: PlatformEventEmitter

Accessors

Methods

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

Constructors

Properties

eventEmitter: PlatformEventEmitter

Accessors

Methods

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

    -
+
diff --git a/classes/_openfeature_web_sdk.InMemoryProvider.html b/classes/_openfeature_web_sdk.InMemoryProvider.html index 990cadbc3..1ed632dca 100644 --- a/classes/_openfeature_web_sdk.InMemoryProvider.html +++ b/classes/_openfeature_web_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

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

-

Implements

Constructors

Implements

Constructors

Properties

An event emitter for ProviderEvents.

+

Constructors

Properties

An event emitter for ProviderEvents.

ProviderEvents

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

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

metadata: {
    name: "in-memory";
} = ...
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

Methods

+

Returns Promise<void>

diff --git a/classes/_openfeature_web_sdk.InvalidContextError.html b/classes/_openfeature_web_sdk.InvalidContextError.html index 3130062f0..266f7cf4e 100644 --- a/classes/_openfeature_web_sdk.InvalidContextError.html +++ b/classes/_openfeature_web_sdk.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.OpenFeatureAPI.html b/classes/_openfeature_web_sdk.OpenFeatureAPI.html index 9afc42d6d..42d69b8cd 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureAPI.html +++ b/classes/_openfeature_web_sdk.OpenFeatureAPI.html @@ -1,4 +1,4 @@ -OpenFeatureAPI | Documentation

Hierarchy (view full)

Implements

Properties

_apiEmitter +OpenFeatureAPI | Documentation

Hierarchy (view full)

Implements

Properties

_apiEmitter: GenericEventEmitter<ProviderEvents, Record<string, unknown>> = ...
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<Provider, ProviderStatus>> = ...
_hooks: Hook[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

  • get providerMetadata(): ProviderMetadata
  • Get metadata about the default provider.

    +

Properties

_apiEmitter: GenericEventEmitter<ProviderEvents, Record<string, unknown>> = ...
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<Provider, ProviderStatus> = ...
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<Provider, ProviderStatus>> = ...
_hooks: Hook[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

Methods

Methods

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

Returns void

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

    -
  • Resets the global evaluation context to an empty object.

    +

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

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

Returns Promise<void>

Returns void

+
diff --git a/classes/_openfeature_web_sdk.OpenFeatureCommonAPI.html b/classes/_openfeature_web_sdk.OpenFeatureCommonAPI.html index e05e4c788..ada364b46 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

Properties

_apiEmitter: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<P, AnyProviderStatus>
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>
_hooks: H[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ProviderStatus | typeof ServerProviderStatus

Accessors

  • get providerMetadata(): ProviderMetadata
  • Get metadata about the default provider.

    +

Constructors

Properties

_apiEmitter: GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>
_clientEvents: Map<undefined | string, GenericEventEmitter<AnyProviderEvent, Record<string, unknown>>> = ...
_context: EvaluationContext = {}
_defaultProvider: ProviderWrapper<P, AnyProviderStatus>
_domainScopedContext: Map<string, EvaluationContext> = ...
_domainScopedProviders: Map<string, ProviderWrapper<P, AnyProviderStatus>>
_hooks: H[] = []
_logger: Logger = ...
_runsOn: Paradigm
_statusEnumType: typeof ProviderStatus | typeof ServerProviderStatus

Accessors

Methods

Methods

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

Returns void

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

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

    Parameters

    • Optionaldomain: string

      An identifier which logically binds clients with providers

    Returns ProviderMetadata

    Provider Metadata

    -
  • Parameters

    • OptionaldomainOrProvider: string | P
    • OptionalproviderOrUndefined: P

    Returns void | Promise<void>

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

Returns void

+
diff --git a/classes/_openfeature_web_sdk.OpenFeatureError.html b/classes/_openfeature_web_sdk.OpenFeatureError.html index fc2c511c9..98752d51a 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureError.html +++ b/classes/_openfeature_web_sdk.OpenFeatureError.html @@ -1,4 +1,4 @@ -OpenFeatureError | Documentation

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html index d981fe68c..9b441ab47 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

Hierarchy (view full)

Constructors

Properties

Accessors

Methods

Constructors

Properties

eventEmitter: EventEmitter<string | symbol, any> = ...

Accessors

Methods

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

Constructors

Properties

eventEmitter: EventEmitter<string | symbol, any> = ...

Accessors

Methods

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

    -
+
diff --git a/classes/_openfeature_web_sdk.ParseError.html b/classes/_openfeature_web_sdk.ParseError.html index 409d280ba..cae73f561 100644 --- a/classes/_openfeature_web_sdk.ParseError.html +++ b/classes/_openfeature_web_sdk.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.ProviderFatalError.html b/classes/_openfeature_web_sdk.ProviderFatalError.html index 2eb0231d4..95082a59a 100644 --- a/classes/_openfeature_web_sdk.ProviderFatalError.html +++ b/classes/_openfeature_web_sdk.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.ProviderNotReadyError.html b/classes/_openfeature_web_sdk.ProviderNotReadyError.html index 3e0b95fd7..b958c9e23 100644 --- a/classes/_openfeature_web_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_web_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.ProviderWrapper.html b/classes/_openfeature_web_sdk.ProviderWrapper.html index 7fc118328..1a39a0a2c 100644 --- a/classes/_openfeature_web_sdk.ProviderWrapper.html +++ b/classes/_openfeature_web_sdk.ProviderWrapper.html @@ -1,9 +1,9 @@ ProviderWrapper | Documentation

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

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

Accessors

Methods

+

Constructors

Accessors

Methods

diff --git a/classes/_openfeature_web_sdk.SafeLogger.html b/classes/_openfeature_web_sdk.SafeLogger.html index 403f5abc9..b4886d161 100644 --- a/classes/_openfeature_web_sdk.SafeLogger.html +++ b/classes/_openfeature_web_sdk.SafeLogger.html @@ -1,6 +1,6 @@ -SafeLogger | Documentation

Implements

Constructors

constructor +SafeLogger | Documentation

Implements

Constructors

Methods

Constructors

Methods

+

Constructors

Methods

diff --git a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html index bc42686c5..a30968a76 100644 --- a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html +++ b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/classes/_openfeature_web_sdk.TypeMismatchError.html b/classes/_openfeature_web_sdk.TypeMismatchError.html index 714db7c85..85d280486 100644 --- a/classes/_openfeature_web_sdk.TypeMismatchError.html +++ b/classes/_openfeature_web_sdk.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Constructors

Properties

cause?: unknown
code: ErrorCode
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/enums/_openfeature_core.ClientProviderEvents.html b/enums/_openfeature_core.ClientProviderEvents.html index fa1e9e1e6..834e40f83 100644 --- a/enums/_openfeature_core.ClientProviderEvents.html +++ b/enums/_openfeature_core.ClientProviderEvents.html @@ -1,14 +1,14 @@ ClientProviderEvents | Documentation

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

Enumeration Members

ConfigurationChanged

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

-
ContextChanged

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

-
Error

The provider is in an error state.

-
Ready

The provider is ready to evaluate flags.

-
Reconciling

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

-
Stale

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

-
+
ContextChanged

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

+
Error

The provider is in an error state.

+
Ready

The provider is ready to evaluate flags.

+
Reconciling

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

+
Stale

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

+
diff --git a/enums/_openfeature_core.ClientProviderStatus.html b/enums/_openfeature_core.ClientProviderStatus.html index a905d7fc5..5495eafff 100644 --- a/enums/_openfeature_core.ClientProviderStatus.html +++ b/enums/_openfeature_core.ClientProviderStatus.html @@ -1,15 +1,15 @@ ClientProviderStatus | Documentation

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

-

Enumeration Members

Enumeration Members

ERROR

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

-
FATAL

The provider has entered an irrecoverable error state.

-
NOT_READY

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

-
READY

The provider is ready to resolve flags.

-
RECONCILING

The provider is reconciling its state with a context change.

-
STALE

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

-
+
FATAL

The provider has entered an irrecoverable error state.

+
NOT_READY

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

+
READY

The provider is ready to resolve flags.

+
RECONCILING

The provider is reconciling its state with a context change.

+
STALE

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

+
diff --git a/enums/_openfeature_core.ErrorCode.html b/enums/_openfeature_core.ErrorCode.html index 936382313..79354b410 100644 --- a/enums/_openfeature_core.ErrorCode.html +++ b/enums/_openfeature_core.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration Members

FLAG_NOT_FOUND

The flag could not be found.

-
GENERAL

An error with an unspecified code.

-
INVALID_CONTEXT

The evaluation context does not meet provider requirements.

-
PARSE_ERROR

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

-
PROVIDER_FATAL

The provider has entered an irrecoverable error state.

-
PROVIDER_NOT_READY

The value was resolved before the provider was ready.

-
TARGETING_KEY_MISSING

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

-
TYPE_MISMATCH

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

-
+
GENERAL

An error with an unspecified code.

+
INVALID_CONTEXT

The evaluation context does not meet provider requirements.

+
PARSE_ERROR

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

+
PROVIDER_FATAL

The provider has entered an irrecoverable error state.

+
PROVIDER_NOT_READY

The value was resolved before the provider was ready.

+
TARGETING_KEY_MISSING

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

+
TYPE_MISMATCH

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

+
diff --git a/enums/_openfeature_core.ServerProviderEvents.html b/enums/_openfeature_core.ServerProviderEvents.html index c4501c880..f503caf12 100644 --- a/enums/_openfeature_core.ServerProviderEvents.html +++ b/enums/_openfeature_core.ServerProviderEvents.html @@ -1,10 +1,10 @@ ServerProviderEvents | Documentation

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

Enumeration Members

ConfigurationChanged

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

-
Error

The provider is in an error state.

-
Ready

The provider is ready to evaluate flags.

-
Stale

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

-
+
Error

The provider is in an error state.

+
Ready

The provider is ready to evaluate flags.

+
Stale

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

+
diff --git a/enums/_openfeature_core.ServerProviderStatus.html b/enums/_openfeature_core.ServerProviderStatus.html index ebab4435d..0224922bc 100644 --- a/enums/_openfeature_core.ServerProviderStatus.html +++ b/enums/_openfeature_core.ServerProviderStatus.html @@ -1,13 +1,13 @@ ServerProviderStatus | Documentation

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

-

Enumeration Members

Enumeration Members

Enumeration Members

ERROR

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

-
FATAL

The provider has entered an irrecoverable error state.

-
NOT_READY

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

-
READY

The provider is ready to resolve flags.

-
STALE

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

-
+
FATAL

The provider has entered an irrecoverable error state.

+
NOT_READY

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

+
READY

The provider is ready to resolve flags.

+
STALE

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

+
diff --git a/enums/_openfeature_server_sdk.ClientProviderEvents.html b/enums/_openfeature_server_sdk.ClientProviderEvents.html index bd1008a8f..8ffe7ffe7 100644 --- a/enums/_openfeature_server_sdk.ClientProviderEvents.html +++ b/enums/_openfeature_server_sdk.ClientProviderEvents.html @@ -1,14 +1,14 @@ ClientProviderEvents | Documentation

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

Enumeration Members

ConfigurationChanged

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

-
ContextChanged

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

-
Error

The provider is in an error state.

-
Ready

The provider is ready to evaluate flags.

-
Reconciling

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

-
Stale

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

-
+
ContextChanged

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

+
Error

The provider is in an error state.

+
Ready

The provider is ready to evaluate flags.

+
Reconciling

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

+
Stale

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

+
diff --git a/enums/_openfeature_server_sdk.ClientProviderStatus.html b/enums/_openfeature_server_sdk.ClientProviderStatus.html index feb31a9d1..24d310b28 100644 --- a/enums/_openfeature_server_sdk.ClientProviderStatus.html +++ b/enums/_openfeature_server_sdk.ClientProviderStatus.html @@ -1,15 +1,15 @@ ClientProviderStatus | Documentation

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

-

Enumeration Members

Enumeration Members

ERROR

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

-
FATAL

The provider has entered an irrecoverable error state.

-
NOT_READY

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

-
READY

The provider is ready to resolve flags.

-
RECONCILING

The provider is reconciling its state with a context change.

-
STALE

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

-
+
FATAL

The provider has entered an irrecoverable error state.

+
NOT_READY

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

+
READY

The provider is ready to resolve flags.

+
RECONCILING

The provider is reconciling its state with a context change.

+
STALE

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

+
diff --git a/enums/_openfeature_server_sdk.ErrorCode.html b/enums/_openfeature_server_sdk.ErrorCode.html index 027d274d2..8ddc63895 100644 --- a/enums/_openfeature_server_sdk.ErrorCode.html +++ b/enums/_openfeature_server_sdk.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration Members

FLAG_NOT_FOUND

The flag could not be found.

-
GENERAL

An error with an unspecified code.

-
INVALID_CONTEXT

The evaluation context does not meet provider requirements.

-
PARSE_ERROR

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

-
PROVIDER_FATAL

The provider has entered an irrecoverable error state.

-
PROVIDER_NOT_READY

The value was resolved before the provider was ready.

-
TARGETING_KEY_MISSING

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

-
TYPE_MISMATCH

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

-
+
GENERAL

An error with an unspecified code.

+
INVALID_CONTEXT

The evaluation context does not meet provider requirements.

+
PARSE_ERROR

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

+
PROVIDER_FATAL

The provider has entered an irrecoverable error state.

+
PROVIDER_NOT_READY

The value was resolved before the provider was ready.

+
TARGETING_KEY_MISSING

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

+
TYPE_MISMATCH

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

+
diff --git a/enums/_openfeature_server_sdk.ProviderEvents.html b/enums/_openfeature_server_sdk.ProviderEvents.html index e1d0a8c11..3469057b9 100644 --- a/enums/_openfeature_server_sdk.ProviderEvents.html +++ b/enums/_openfeature_server_sdk.ProviderEvents.html @@ -1,10 +1,10 @@ ProviderEvents | Documentation

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

Enumeration Members

ConfigurationChanged

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

-
Error

The provider is in an error state.

-
Ready

The provider is ready to evaluate flags.

-
Stale

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

-
+
Error

The provider is in an error state.

+
Ready

The provider is ready to evaluate flags.

+
Stale

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

+
diff --git a/enums/_openfeature_server_sdk.ProviderStatus.html b/enums/_openfeature_server_sdk.ProviderStatus.html index 7f33b7674..25fcdd748 100644 --- a/enums/_openfeature_server_sdk.ProviderStatus.html +++ b/enums/_openfeature_server_sdk.ProviderStatus.html @@ -1,13 +1,13 @@ ProviderStatus | Documentation

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

-

Enumeration Members

Enumeration Members

Enumeration Members

ERROR

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

-
FATAL

The provider has entered an irrecoverable error state.

-
NOT_READY

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

-
READY

The provider is ready to resolve flags.

-
STALE

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

-
+
FATAL

The provider has entered an irrecoverable error state.

+
NOT_READY

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

+
READY

The provider is ready to resolve flags.

+
STALE

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

+
diff --git a/enums/_openfeature_web_sdk.ErrorCode.html b/enums/_openfeature_web_sdk.ErrorCode.html index b64035fe8..0d44ea72f 100644 --- a/enums/_openfeature_web_sdk.ErrorCode.html +++ b/enums/_openfeature_web_sdk.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration Members

FLAG_NOT_FOUND

The flag could not be found.

-
GENERAL

An error with an unspecified code.

-
INVALID_CONTEXT

The evaluation context does not meet provider requirements.

-
PARSE_ERROR

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

-
PROVIDER_FATAL

The provider has entered an irrecoverable error state.

-
PROVIDER_NOT_READY

The value was resolved before the provider was ready.

-
TARGETING_KEY_MISSING

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

-
TYPE_MISMATCH

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

-
+
GENERAL

An error with an unspecified code.

+
INVALID_CONTEXT

The evaluation context does not meet provider requirements.

+
PARSE_ERROR

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

+
PROVIDER_FATAL

The provider has entered an irrecoverable error state.

+
PROVIDER_NOT_READY

The value was resolved before the provider was ready.

+
TARGETING_KEY_MISSING

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

+
TYPE_MISMATCH

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

+
diff --git a/enums/_openfeature_web_sdk.ProviderEvents.html b/enums/_openfeature_web_sdk.ProviderEvents.html index 3f3eb6fff..09a51dbe2 100644 --- a/enums/_openfeature_web_sdk.ProviderEvents.html +++ b/enums/_openfeature_web_sdk.ProviderEvents.html @@ -1,14 +1,14 @@ ProviderEvents | Documentation

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

Enumeration Members

ConfigurationChanged

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

-
ContextChanged

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

-
Error

The provider is in an error state.

-
Ready

The provider is ready to evaluate flags.

-
Reconciling

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

-
Stale

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

-
+
ContextChanged

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

+
Error

The provider is in an error state.

+
Ready

The provider is ready to evaluate flags.

+
Reconciling

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

+
Stale

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

+
diff --git a/enums/_openfeature_web_sdk.ProviderStatus.html b/enums/_openfeature_web_sdk.ProviderStatus.html index a988ea549..3e18753cb 100644 --- a/enums/_openfeature_web_sdk.ProviderStatus.html +++ b/enums/_openfeature_web_sdk.ProviderStatus.html @@ -1,15 +1,15 @@ ProviderStatus | Documentation

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

-

Enumeration Members

Enumeration Members

ERROR

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

-
FATAL

The provider has entered an irrecoverable error state.

-
NOT_READY

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

-
READY

The provider is ready to resolve flags.

-
RECONCILING

The provider is reconciling its state with a context change.

-
STALE

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

-
+
FATAL

The provider has entered an irrecoverable error state.

+
NOT_READY

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

+
READY

The provider is ready to resolve flags.

+
RECONCILING

The provider is reconciling its state with a context change.

+
STALE

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

+
diff --git a/enums/_openfeature_web_sdk.ServerProviderEvents.html b/enums/_openfeature_web_sdk.ServerProviderEvents.html index 5a7d13289..ffba71f66 100644 --- a/enums/_openfeature_web_sdk.ServerProviderEvents.html +++ b/enums/_openfeature_web_sdk.ServerProviderEvents.html @@ -1,10 +1,10 @@ ServerProviderEvents | Documentation

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

Enumeration Members

ConfigurationChanged

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

-
Error

The provider is in an error state.

-
Ready

The provider is ready to evaluate flags.

-
Stale

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

-
+
Error

The provider is in an error state.

+
Ready

The provider is ready to evaluate flags.

+
Stale

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

+
diff --git a/enums/_openfeature_web_sdk.ServerProviderStatus.html b/enums/_openfeature_web_sdk.ServerProviderStatus.html index 03273d8b0..d7a6b0afc 100644 --- a/enums/_openfeature_web_sdk.ServerProviderStatus.html +++ b/enums/_openfeature_web_sdk.ServerProviderStatus.html @@ -1,13 +1,13 @@ ServerProviderStatus | Documentation

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

-

Enumeration Members

Enumeration Members

Enumeration Members

ERROR

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

-
FATAL

The provider has entered an irrecoverable error state.

-
NOT_READY

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

-
READY

The provider is ready to resolve flags.

-
STALE

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

-
+
FATAL

The provider has entered an irrecoverable error state.

+
NOT_READY

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

+
READY

The provider is ready to resolve flags.

+
STALE

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

+
diff --git a/functions/_openfeature_core.instantiateErrorByErrorCode.html b/functions/_openfeature_core.instantiateErrorByErrorCode.html index 040b6c207..78a29183f 100644 --- a/functions/_openfeature_core.instantiateErrorByErrorCode.html +++ b/functions/_openfeature_core.instantiateErrorByErrorCode.html @@ -1 +1 @@ -instantiateErrorByErrorCode | Documentation
+instantiateErrorByErrorCode | Documentation
diff --git a/functions/_openfeature_core.isObject.html b/functions/_openfeature_core.isObject.html index ee78baf03..f8329d1b6 100644 --- a/functions/_openfeature_core.isObject.html +++ b/functions/_openfeature_core.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_core.isString.html b/functions/_openfeature_core.isString.html index 6dcd33025..5a7c2c169 100644 --- a/functions/_openfeature_core.isString.html +++ b/functions/_openfeature_core.isString.html @@ -1,4 +1,4 @@ isString | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_core.objectOrUndefined.html b/functions/_openfeature_core.objectOrUndefined.html index 047e5f329..78606c085 100644 --- a/functions/_openfeature_core.objectOrUndefined.html +++ b/functions/_openfeature_core.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_core.statusMatchesEvent.html b/functions/_openfeature_core.statusMatchesEvent.html index f671592a4..e4b53dba8 100644 --- a/functions/_openfeature_core.statusMatchesEvent.html +++ b/functions/_openfeature_core.statusMatchesEvent.html @@ -3,4 +3,4 @@
+
diff --git a/functions/_openfeature_core.stringOrUndefined.html b/functions/_openfeature_core.stringOrUndefined.html index ba90e0a2a..99d0f30dc 100644 --- a/functions/_openfeature_core.stringOrUndefined.html +++ b/functions/_openfeature_core.stringOrUndefined.html @@ -1,4 +1,4 @@ stringOrUndefined | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html b/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html index 20a688c5b..dcd20cac4 100644 --- a/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html +++ b/functions/_openfeature_server_sdk.instantiateErrorByErrorCode.html @@ -1 +1 @@ -instantiateErrorByErrorCode | Documentation
+instantiateErrorByErrorCode | Documentation
diff --git a/functions/_openfeature_server_sdk.isObject.html b/functions/_openfeature_server_sdk.isObject.html index 775ca94af..e28a0c382 100644 --- a/functions/_openfeature_server_sdk.isObject.html +++ b/functions/_openfeature_server_sdk.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_server_sdk.isString.html b/functions/_openfeature_server_sdk.isString.html index 8b90e018c..e92afd54c 100644 --- a/functions/_openfeature_server_sdk.isString.html +++ b/functions/_openfeature_server_sdk.isString.html @@ -1,4 +1,4 @@ isString | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_server_sdk.objectOrUndefined.html b/functions/_openfeature_server_sdk.objectOrUndefined.html index 9704c01ef..271b6ccf0 100644 --- a/functions/_openfeature_server_sdk.objectOrUndefined.html +++ b/functions/_openfeature_server_sdk.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_server_sdk.statusMatchesEvent.html b/functions/_openfeature_server_sdk.statusMatchesEvent.html index 3357ef308..28d090e9b 100644 --- a/functions/_openfeature_server_sdk.statusMatchesEvent.html +++ b/functions/_openfeature_server_sdk.statusMatchesEvent.html @@ -3,4 +3,4 @@
+
diff --git a/functions/_openfeature_server_sdk.stringOrUndefined.html b/functions/_openfeature_server_sdk.stringOrUndefined.html index 0ea35a559..05cf38865 100644 --- a/functions/_openfeature_server_sdk.stringOrUndefined.html +++ b/functions/_openfeature_server_sdk.stringOrUndefined.html @@ -1,4 +1,4 @@ stringOrUndefined | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html b/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html index e264e1b93..a7242ed21 100644 --- a/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html +++ b/functions/_openfeature_web_sdk.instantiateErrorByErrorCode.html @@ -1 +1 @@ -instantiateErrorByErrorCode | Documentation
+instantiateErrorByErrorCode | Documentation
diff --git a/functions/_openfeature_web_sdk.isObject.html b/functions/_openfeature_web_sdk.isObject.html index 14d4c81a2..02aa15bc2 100644 --- a/functions/_openfeature_web_sdk.isObject.html +++ b/functions/_openfeature_web_sdk.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_web_sdk.isString.html b/functions/_openfeature_web_sdk.isString.html index 8936eff0b..f1ab06a54 100644 --- a/functions/_openfeature_web_sdk.isString.html +++ b/functions/_openfeature_web_sdk.isString.html @@ -1,4 +1,4 @@ isString | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_web_sdk.objectOrUndefined.html b/functions/_openfeature_web_sdk.objectOrUndefined.html index 67954ecda..291fc5ac3 100644 --- a/functions/_openfeature_web_sdk.objectOrUndefined.html +++ b/functions/_openfeature_web_sdk.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation
  • 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

    -
+
diff --git a/functions/_openfeature_web_sdk.statusMatchesEvent.html b/functions/_openfeature_web_sdk.statusMatchesEvent.html index 53ee64f85..b0398441a 100644 --- a/functions/_openfeature_web_sdk.statusMatchesEvent.html +++ b/functions/_openfeature_web_sdk.statusMatchesEvent.html @@ -3,4 +3,4 @@
+
diff --git a/functions/_openfeature_web_sdk.stringOrUndefined.html b/functions/_openfeature_web_sdk.stringOrUndefined.html index a0ccd6a8e..de55e16cc 100644 --- a/functions/_openfeature_web_sdk.stringOrUndefined.html +++ b/functions/_openfeature_web_sdk.stringOrUndefined.html @@ -1,4 +1,4 @@ stringOrUndefined | Documentation
  • 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

    -
+
diff --git a/interfaces/_openfeature_core.BaseHook.html b/interfaces/_openfeature_core.BaseHook.html index fd6385722..b4a8cbb91 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: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    before?(hookContext: BeforeHookContext, hookHints?: Readonly<Record<string, unknown>>): BeforeHookReturn;
    error?(hookContext: Readonly<HookContext<T>>, error: unknown, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    finally?(hookContext: Readonly<HookContext<T>>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
}

Type Parameters

Methods

after? +BaseHook | Documentation

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

interface BaseHook<T, BeforeHookReturn, HooksReturn> {
    after?(hookContext: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    before?(hookContext: BeforeHookContext, hookHints?: Readonly<Record<string, unknown>>): BeforeHookReturn;
    error?(hookContext: Readonly<HookContext<T>>, error: unknown, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    finally?(hookContext: Readonly<HookContext<T>>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
}

Type Parameters

Methods

  • 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>>
    • OptionalhookHints: Readonly<Record<string, unknown>>

    Returns HooksReturn

+

Parameters

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

Returns HooksReturn

diff --git a/interfaces/_openfeature_core.BeforeHookContext.html b/interfaces/_openfeature_core.BeforeHookContext.html index eeb2ed1b4..c83224b78 100644 --- a/interfaces/_openfeature_core.BeforeHookContext.html +++ b/interfaces/_openfeature_core.BeforeHookContext.html @@ -1,8 +1,8 @@ -BeforeHookContext | Documentation
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 {
    clientMetadata: ClientMetadata;
    context: EvaluationContext;
    defaultValue: FlagValue;
    flagKey: string;
    flagValueType: FlagValueType;
    logger: Logger;
    providerMetadata: ProviderMetadata;
}

Hierarchy (view full)

Properties

clientMetadata: ClientMetadata
defaultValue: FlagValue
flagKey: string
flagValueType: FlagValueType
logger: Logger
providerMetadata: ProviderMetadata
+

Properties

clientMetadata: ClientMetadata
defaultValue: FlagValue
flagKey: string
flagValueType: FlagValueType
logger: Logger
providerMetadata: ProviderMetadata
diff --git a/interfaces/_openfeature_core.ClientMetadata.html b/interfaces/_openfeature_core.ClientMetadata.html index a6b13620b..92cc25df8 100644 --- a/interfaces/_openfeature_core.ClientMetadata.html +++ b/interfaces/_openfeature_core.ClientMetadata.html @@ -1,6 +1,6 @@ -ClientMetadata | Documentation
interface ClientMetadata {
    domain?: string;
    name?: string;
    providerMetadata: ProviderMetadata;
    version?: string;
}

Properties

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

Properties

domain?: string
name?: string

alias of "domain", use domain instead

-
providerMetadata: ProviderMetadata
version?: string
+

Properties

domain?: string
name?: string

alias of "domain", use domain instead

+
providerMetadata: ProviderMetadata
version?: string
diff --git a/interfaces/_openfeature_core.CommonProvider.html b/interfaces/_openfeature_core.CommonProvider.html index 3b723a3e6..cf5f89a4a 100644 --- a/interfaces/_openfeature_core.CommonProvider.html +++ b/interfaces/_openfeature_core.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation
interface CommonProvider<S> {
    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
    metadata: ProviderMetadata;
    runsOn?: Paradigm;
    status?: S;
    initialize?(context?: EvaluationContext): Promise<void>;
    onClose?(): Promise<void>;
    track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
}

Type Parameters

Properties

events? +CommonProvider | Documentation
interface CommonProvider<S> {
    events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
    metadata: ProviderMetadata;
    runsOn?: Paradigm;
    status?: S;
    initialize?(context?: EvaluationContext): Promise<void>;
    onClose?(): Promise<void>;
    track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
}

Type Parameters

Properties

Properties

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

An event emitter for ProviderEvents.

ProviderEvents

-
runsOn?: Paradigm

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

runsOn?: Paradigm

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

-
status?: S

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

status?: S

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

  • A function used to setup the provider. +

Methods

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

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

+

Returns Promise<void>

diff --git a/interfaces/_openfeature_core.EvaluationLifeCycle.html b/interfaces/_openfeature_core.EvaluationLifeCycle.html index c98fed3e9..848858163 100644 --- a/interfaces/_openfeature_core.EvaluationLifeCycle.html +++ b/interfaces/_openfeature_core.EvaluationLifeCycle.html @@ -1,4 +1,4 @@ -EvaluationLifeCycle | Documentation
interface EvaluationLifeCycle<T> {
    addHooks(...hooks: BaseHook<FlagValue, unknown, unknown>[]): T;
    clearHooks(): T;
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
}

Type Parameters

  • T

Implemented by

Methods

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

Type Parameters

  • T

Implemented by

Methods

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

    -
+
diff --git a/interfaces/_openfeature_core.Eventing.html b/interfaces/_openfeature_core.Eventing.html index 92c194087..b84661d91 100644 --- a/interfaces/_openfeature_core.Eventing.html +++ b/interfaces/_openfeature_core.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation
interface Eventing<T> {
    addHandler(eventType: T extends ClientProviderEvents
        ? ConfigurationChanged
        : ConfigurationChanged, handler: EventHandler<T extends ClientProviderEvents
        ? ConfigurationChanged
        : ConfigurationChanged>): void;
    addHandler(eventType: T extends ClientProviderEvents
        ? ClientNotChangeEvents
        : ServerNotChangeEvents, handler: EventHandler<T extends ClientProviderEvents
        ? ClientNotChangeEvents
        : ServerNotChangeEvents>): void;
    addHandler(eventType: T extends ClientProviderEvents
        ? ClientProviderEvents
        : ServerProviderEvents, handler: EventHandler<T extends ClientProviderEvents
        ? ClientProviderEvents
        : ServerProviderEvents>): void;
    getHandlers(eventType: T): EventHandler<T>[];
    removeHandler(eventType: T, handler: EventHandler<T>): void;
}

Type Parameters

Implemented by

Methods

addHandler +Eventing | Documentation
interface Eventing<T> {
    addHandler(eventType: T extends ClientProviderEvents
        ? ConfigurationChanged
        : ConfigurationChanged, handler: EventHandler<T extends ClientProviderEvents
        ? ConfigurationChanged
        : ConfigurationChanged>): void;
    addHandler(eventType: T extends ClientProviderEvents
        ? ClientNotChangeEvents
        : ServerNotChangeEvents, handler: EventHandler<T extends ClientProviderEvents
        ? ClientNotChangeEvents
        : ServerNotChangeEvents>): void;
    addHandler(eventType: T extends ClientProviderEvents
        ? ClientProviderEvents
        : ServerProviderEvents, handler: EventHandler<T extends ClientProviderEvents
        ? ClientProviderEvents
        : ServerProviderEvents>): void;
    getHandlers(eventType: T): EventHandler<T>[];
    removeHandler(eventType: T, handler: EventHandler<T>): void;
}

Type Parameters

Implemented by

Methods

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

    +

Returns void

  • Parameters

    Returns void

  • Parameters

    Returns 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

    +

    Returns void

    diff --git a/interfaces/_openfeature_core.HookContext.html b/interfaces/_openfeature_core.HookContext.html index 7b87d828b..e964fd49b 100644 --- a/interfaces/_openfeature_core.HookContext.html +++ b/interfaces/_openfeature_core.HookContext.html @@ -1,8 +1,8 @@ -HookContext | Documentation
    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> {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata: ClientMetadata
    context: Readonly<EvaluationContext>
    defaultValue: T
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    +

    Properties

    clientMetadata: ClientMetadata
    context: Readonly<EvaluationContext>
    defaultValue: T
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    diff --git a/interfaces/_openfeature_core.Logger.html b/interfaces/_openfeature_core.Logger.html index 196b0a523..15fc5ddc6 100644 --- a/interfaces/_openfeature_core.Logger.html +++ b/interfaces/_openfeature_core.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation
    interface Logger {
        debug(...args: unknown[]): void;
        error(...args: unknown[]): void;
        info(...args: unknown[]): void;
        warn(...args: unknown[]): void;
    }

    Implemented by

    Methods

    debug +Logger | Documentation
    interface Logger {
        debug(...args: unknown[]): void;
        error(...args: unknown[]): void;
        info(...args: unknown[]): void;
        warn(...args: unknown[]): void;
    }

    Implemented by

    Methods

    Methods

    +

    Methods

    diff --git a/interfaces/_openfeature_core.ManageContext.html b/interfaces/_openfeature_core.ManageContext.html index cd329c32f..2ae826e3c 100644 --- a/interfaces/_openfeature_core.ManageContext.html +++ b/interfaces/_openfeature_core.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation
    interface ManageContext<T> {
        getContext(): EvaluationContext;
        setContext(context: EvaluationContext): T;
    }

    Type Parameters

    • T

    Methods

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

    Type Parameters

    • T

    Methods

    +
    diff --git a/interfaces/_openfeature_core.ManageLogger.html b/interfaces/_openfeature_core.ManageLogger.html index 57c394fea..274413510 100644 --- a/interfaces/_openfeature_core.ManageLogger.html +++ b/interfaces/_openfeature_core.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation
    interface ManageLogger<T> {
        setLogger(logger: Logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation
    interface ManageLogger<T> {
        setLogger(logger: Logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    Methods

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

      -
    +
    diff --git a/interfaces/_openfeature_core.ProviderEventEmitter.html b/interfaces/_openfeature_core.ProviderEventEmitter.html index f5b70561c..73b588fcf 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

    OpenFeatureEventEmitter.

    -
    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ClientProviderEvents>): void;
        emit(eventType: E, context?: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>): void;
        getHandlers(eventType: AnyProviderEvent): EventHandler<ServerProviderEvents | ClientProviderEvents>[];
        removeAllHandlers(eventType?: AnyProviderEvent): void;
        removeHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ClientProviderEvents>): void;
        setLogger(logger: Logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ClientProviderEvents>): void;
        emit(eventType: E, context?: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>): void;
        getHandlers(eventType: AnyProviderEvent): EventHandler<ServerProviderEvents | ClientProviderEvents>[];
        removeAllHandlers(eventType?: AnyProviderEvent): void;
        removeHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ClientProviderEvents>): void;
        setLogger(logger: Logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    Methods

    +
    diff --git a/interfaces/_openfeature_core.ProviderMetadata.html b/interfaces/_openfeature_core.ProviderMetadata.html index 01f4a80dd..e6ce7a3cc 100644 --- a/interfaces/_openfeature_core.ProviderMetadata.html +++ b/interfaces/_openfeature_core.ProviderMetadata.html @@ -1,3 +1,3 @@ ProviderMetadata | Documentation

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    Properties

    name: string
    +
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    Properties

    name: string
    diff --git a/interfaces/_openfeature_server_sdk.BaseHook.html b/interfaces/_openfeature_server_sdk.BaseHook.html index da66a7a5b..4fec13951 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: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        before?(hookContext: BeforeHookContext, hookHints?: Readonly<Record<string, unknown>>): BeforeHookReturn;
        error?(hookContext: Readonly<HookContext<T>>, error: unknown, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        finally?(hookContext: Readonly<HookContext<T>>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    }

    Type Parameters

    Methods

    after? +BaseHook | Documentation

    Interface BaseHook<T, BeforeHookReturn, HooksReturn>

    interface BaseHook<T, BeforeHookReturn, HooksReturn> {
        after?(hookContext: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        before?(hookContext: BeforeHookContext, hookHints?: Readonly<Record<string, unknown>>): BeforeHookReturn;
        error?(hookContext: Readonly<HookContext<T>>, error: unknown, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        finally?(hookContext: Readonly<HookContext<T>>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    }

    Type Parameters

    Methods

    • 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>>
      • OptionalhookHints: Readonly<Record<string, unknown>>

      Returns HooksReturn

    +

    Parameters

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

    Returns HooksReturn

    diff --git a/interfaces/_openfeature_server_sdk.BeforeHookContext.html b/interfaces/_openfeature_server_sdk.BeforeHookContext.html index a850e7b37..221d2d3c6 100644 --- a/interfaces/_openfeature_server_sdk.BeforeHookContext.html +++ b/interfaces/_openfeature_server_sdk.BeforeHookContext.html @@ -1,8 +1,8 @@ -BeforeHookContext | Documentation
    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 {
        clientMetadata: ClientMetadata;
        context: EvaluationContext;
        defaultValue: FlagValue;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Hierarchy (view full)

    Properties

    clientMetadata: ClientMetadata
    defaultValue: FlagValue
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    +

    Properties

    clientMetadata: ClientMetadata
    defaultValue: FlagValue
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    diff --git a/interfaces/_openfeature_server_sdk.Client.html b/interfaces/_openfeature_server_sdk.Client.html index 4afb8d485..752689a33 100644 --- a/interfaces/_openfeature_server_sdk.Client.html +++ b/interfaces/_openfeature_server_sdk.Client.html @@ -1,4 +1,4 @@ -Client | Documentation
    interface Client {
        metadata: ClientMetadata;
        providerStatus: ProviderStatus;
        addHandler(eventType: ConfigurationChanged, handler: EventHandler<ConfigurationChanged>): void;
        addHandler(eventType: ServerNotChangeEvents, handler: EventHandler<ServerNotChangeEvents>): void;
        addHandler(eventType: ProviderEvents, handler: EventHandler<ProviderEvents>): void;
        addHooks(...hooks: BaseHook<FlagValue, unknown, unknown>[]): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<boolean>>;
        getBooleanValue(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<boolean>;
        getContext(): EvaluationContext;
        getHandlers(eventType: ProviderEvents): EventHandler<ProviderEvents>[];
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
        getNumberDetails(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<number>>;
        getNumberDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getNumberValue(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<number>;
        getNumberValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        getObjectDetails(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<JsonValue>>;
        getObjectDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getObjectValue(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<JsonValue>;
        getObjectValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        getStringDetails(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<string>>;
        getStringDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getStringValue(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<string>;
        getStringValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        removeHandler(eventType: ProviderEvents, handler: EventHandler<ProviderEvents>): void;
        setContext(context: EvaluationContext): Client;
        setLogger(logger: Logger): Client;
        track(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Properties

    metadata +Client | Documentation
    interface Client {
        metadata: ClientMetadata;
        providerStatus: ProviderStatus;
        addHandler(eventType: ConfigurationChanged, handler: EventHandler<ConfigurationChanged>): void;
        addHandler(eventType: ServerNotChangeEvents, handler: EventHandler<ServerNotChangeEvents>): void;
        addHandler(eventType: ProviderEvents, handler: EventHandler<ProviderEvents>): void;
        addHooks(...hooks: BaseHook<FlagValue, unknown, unknown>[]): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<boolean>>;
        getBooleanValue(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<boolean>;
        getContext(): EvaluationContext;
        getHandlers(eventType: ProviderEvents): EventHandler<ProviderEvents>[];
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
        getNumberDetails(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<number>>;
        getNumberDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getNumberValue(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<number>;
        getNumberValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        getObjectDetails(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<JsonValue>>;
        getObjectDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getObjectValue(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<JsonValue>;
        getObjectValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        getStringDetails(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<string>>;
        getStringDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getStringValue(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<string>;
        getStringValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        removeHandler(eventType: ProviderEvents, handler: EventHandler<ProviderEvents>): void;
        setContext(context: EvaluationContext): Client;
        setLogger(logger: Logger): Client;
        track(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Properties

    Methods

    Properties

    metadata: ClientMetadata
    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    -

    Methods

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

    Properties

    metadata: ClientMetadata
    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    +

    Methods

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

    Returns void

  • Parameters

    • eventType: ServerNotChangeEvents
    • handler: EventHandler<ServerNotChangeEvents>

    Returns void

  • Parameters

    Returns void

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

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

      • Optionalcontext: EvaluationContext

        The evaluation context used on an individual flag evaluation

      • Optionaloptions: FlagEvaluationOptions

        Additional flag evaluation options

      Returns Promise<boolean>

      Flag evaluation response

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

    Returns void

    +

    Returns void

    diff --git a/interfaces/_openfeature_server_sdk.ClientMetadata.html b/interfaces/_openfeature_server_sdk.ClientMetadata.html index cad96f35b..ea864159c 100644 --- a/interfaces/_openfeature_server_sdk.ClientMetadata.html +++ b/interfaces/_openfeature_server_sdk.ClientMetadata.html @@ -1,6 +1,6 @@ -ClientMetadata | Documentation
    interface ClientMetadata {
        domain?: string;
        name?: string;
        providerMetadata: ProviderMetadata;
        version?: string;
    }

    Properties

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

    Properties

    domain?: string
    name?: string

    alias of "domain", use domain instead

    -
    providerMetadata: ProviderMetadata
    version?: string
    +

    Properties

    domain?: string
    name?: string

    alias of "domain", use domain instead

    +
    providerMetadata: ProviderMetadata
    version?: string
    diff --git a/interfaces/_openfeature_server_sdk.CommonProvider.html b/interfaces/_openfeature_server_sdk.CommonProvider.html index 71cd839de..cf971e865 100644 --- a/interfaces/_openfeature_server_sdk.CommonProvider.html +++ b/interfaces/_openfeature_server_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation
    interface CommonProvider<S> {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: S;
        initialize?(context?: EvaluationContext): Promise<void>;
        onClose?(): Promise<void>;
        track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    events? +CommonProvider | Documentation
    interface CommonProvider<S> {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: S;
        initialize?(context?: EvaluationContext): Promise<void>;
        onClose?(): Promise<void>;
        track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    Properties

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

    An event emitter for ProviderEvents.

    ProviderEvents

    -
    runsOn?: Paradigm

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

    runsOn?: Paradigm

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

    -
    status?: S

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

    status?: S

    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

    • A function used to setup the provider. +

    Methods

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

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

    +

    Returns Promise<void>

    diff --git a/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html index a1f4413c5..68103897b 100644 --- a/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html +++ b/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html @@ -1,4 +1,4 @@ -EvaluationLifeCycle | Documentation
    interface EvaluationLifeCycle<T> {
        addHooks(...hooks: BaseHook<FlagValue, unknown, unknown>[]): T;
        clearHooks(): T;
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

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

      -
    +
    diff --git a/interfaces/_openfeature_server_sdk.Eventing.html b/interfaces/_openfeature_server_sdk.Eventing.html index 188feea9e..6a5dd372c 100644 --- a/interfaces/_openfeature_server_sdk.Eventing.html +++ b/interfaces/_openfeature_server_sdk.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation
    interface Eventing<T> {
        addHandler(eventType: T extends ClientProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged, handler: EventHandler<T extends ClientProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged>): void;
        addHandler(eventType: T extends ClientProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents, handler: EventHandler<T extends ClientProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents>): void;
        addHandler(eventType: T extends ClientProviderEvents
            ? ClientProviderEvents
            : ProviderEvents, handler: EventHandler<T extends ClientProviderEvents
            ? ClientProviderEvents
            : ProviderEvents>): void;
        getHandlers(eventType: T): EventHandler<T>[];
        removeHandler(eventType: T, handler: EventHandler<T>): void;
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +Eventing | Documentation
    interface Eventing<T> {
        addHandler(eventType: T extends ClientProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged, handler: EventHandler<T extends ClientProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged>): void;
        addHandler(eventType: T extends ClientProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents, handler: EventHandler<T extends ClientProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents>): void;
        addHandler(eventType: T extends ClientProviderEvents
            ? ClientProviderEvents
            : ProviderEvents, handler: EventHandler<T extends ClientProviderEvents
            ? ClientProviderEvents
            : ProviderEvents>): void;
        getHandlers(eventType: T): EventHandler<T>[];
        removeHandler(eventType: T, handler: EventHandler<T>): void;
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

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

      +

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns 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

    +

    Returns void

    diff --git a/interfaces/_openfeature_server_sdk.Features.html b/interfaces/_openfeature_server_sdk.Features.html index 26f35f1ad..aa4c9be28 100644 --- a/interfaces/_openfeature_server_sdk.Features.html +++ b/interfaces/_openfeature_server_sdk.Features.html @@ -1,4 +1,4 @@ -Features | Documentation
    interface Features {
        getBooleanDetails(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<boolean>>;
        getBooleanValue(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<boolean>;
        getNumberDetails(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<number>>;
        getNumberDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getNumberValue(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<number>;
        getNumberValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        getObjectDetails(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<JsonValue>>;
        getObjectDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getObjectValue(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<JsonValue>;
        getObjectValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
        getStringDetails(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<string>>;
        getStringDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
        getStringValue(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<string>;
        getStringValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
    }

    Hierarchy (view full)

    Methods

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

    Hierarchy (view full)

    Methods

  • Optionalcontext: EvaluationContext

    The evaluation context used on an individual flag evaluation

  • Optionaloptions: FlagEvaluationOptions

    Additional flag evaluation options

  • Returns Promise<EvaluationDetails<boolean>>

    Flag evaluation details response

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

      • Optionalcontext: EvaluationContext

        The evaluation context used on an individual flag evaluation

      • Optionaloptions: FlagEvaluationOptions

        Additional flag evaluation options

      Returns Promise<boolean>

      Flag evaluation response

      -
    +
  • Type Parameters

    • T extends string = string

    Parameters

    Returns Promise<T>

  • diff --git a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html index 4fcf8ceb7..f6e89a1e4 100644 --- a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html +++ b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html @@ -1,3 +1,3 @@ -FlagEvaluationOptions | Documentation
    interface FlagEvaluationOptions {
        hookHints?: Readonly<Record<string, unknown>>;
        hooks?: Hook[];
    }

    Properties

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

    Properties

    Properties

    hookHints?: Readonly<Record<string, unknown>>
    hooks?: Hook[]
    +

    Properties

    hookHints?: Readonly<Record<string, unknown>>
    hooks?: Hook[]
    diff --git a/interfaces/_openfeature_server_sdk.HookContext.html b/interfaces/_openfeature_server_sdk.HookContext.html index 0eca394f3..b58a6adcb 100644 --- a/interfaces/_openfeature_server_sdk.HookContext.html +++ b/interfaces/_openfeature_server_sdk.HookContext.html @@ -1,8 +1,8 @@ -HookContext | Documentation
    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> {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata: ClientMetadata
    context: Readonly<EvaluationContext>
    defaultValue: T
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    +

    Properties

    clientMetadata: ClientMetadata
    context: Readonly<EvaluationContext>
    defaultValue: T
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    diff --git a/interfaces/_openfeature_server_sdk.Logger.html b/interfaces/_openfeature_server_sdk.Logger.html index c93ea6434..d5fd5afcd 100644 --- a/interfaces/_openfeature_server_sdk.Logger.html +++ b/interfaces/_openfeature_server_sdk.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation
    interface Logger {
        debug(...args: unknown[]): void;
        error(...args: unknown[]): void;
        info(...args: unknown[]): void;
        warn(...args: unknown[]): void;
    }

    Implemented by

    Methods

    debug +Logger | Documentation
    interface Logger {
        debug(...args: unknown[]): void;
        error(...args: unknown[]): void;
        info(...args: unknown[]): void;
        warn(...args: unknown[]): void;
    }

    Implemented by

    Methods

    Methods

    +

    Methods

    diff --git a/interfaces/_openfeature_server_sdk.ManageContext.html b/interfaces/_openfeature_server_sdk.ManageContext.html index 858e56e09..947f38872 100644 --- a/interfaces/_openfeature_server_sdk.ManageContext.html +++ b/interfaces/_openfeature_server_sdk.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation
    interface ManageContext<T> {
        getContext(): EvaluationContext;
        setContext(context: EvaluationContext): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    +
    diff --git a/interfaces/_openfeature_server_sdk.ManageLogger.html b/interfaces/_openfeature_server_sdk.ManageLogger.html index 30815a2a9..02c3f535f 100644 --- a/interfaces/_openfeature_server_sdk.ManageLogger.html +++ b/interfaces/_openfeature_server_sdk.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation
    interface ManageLogger<T> {
        setLogger(logger: Logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation
    interface ManageLogger<T> {
        setLogger(logger: Logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    Methods

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

      -
    +
    diff --git a/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html b/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html index feb4f24ad..ffb6bd030 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: EvaluationContext, callback: ((...args: TArgs) => R), ...args: TArgs): void;
        setTransactionContextPropagator(transactionContextPropagator: 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: EvaluationContext, callback: ((...args: TArgs) => R), ...args: TArgs): void;
        setTransactionContextPropagator(transactionContextPropagator: TransactionContextPropagator): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    • 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,9 +19,9 @@

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

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

      Callback function to run

        • (...args): R
        • Parameters

          Returns R

    • Rest...args: TArgs

      Optional arguments that are passed to the callback function

      -

    Returns void

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

    Returns void

    +
    diff --git a/interfaces/_openfeature_server_sdk.Provider.html b/interfaces/_openfeature_server_sdk.Provider.html index ff14e471f..b0d15ef0e 100644 --- a/interfaces/_openfeature_server_sdk.Provider.html +++ b/interfaces/_openfeature_server_sdk.Provider.html @@ -1,7 +1,7 @@ Provider | Documentation

    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?: EvaluationContext): Promise<void>;
        onClose?(): Promise<void>;
        resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>;
        resolveNumberEvaluation(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>;
        resolveObjectEvaluation<T>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>;
        resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>;
        track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Implemented by

    Properties

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

    Hierarchy (view full)

    Implemented by

    Properties

    events? hooks? metadata runsOn? @@ -15,25 +15,25 @@ track?

    Properties

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

    An event emitter for ProviderEvents.

    ProviderEvents

    -
    hooks?: Hook[]

    A provider hook exposes a mechanism for provider authors to register 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.

    -
    runsOn?: Paradigm

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

    runsOn?: Paradigm

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

    -

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

    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

    • A function used to setup the provider. +

    Methods

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

    +

    Returns Promise<void>

    diff --git a/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html b/interfaces/_openfeature_server_sdk.ProviderEventEmitter.html index 0a35a5905..52e333d85 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

    OpenFeatureEventEmitter.

    -
    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType: AnyProviderEvent, handler: EventHandler<ProviderEvents | ClientProviderEvents>): void;
        emit(eventType: E, context?: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>): void;
        getHandlers(eventType: AnyProviderEvent): EventHandler<ProviderEvents | ClientProviderEvents>[];
        removeAllHandlers(eventType?: AnyProviderEvent): void;
        removeHandler(eventType: AnyProviderEvent, handler: EventHandler<ProviderEvents | ClientProviderEvents>): void;
        setLogger(logger: Logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType: AnyProviderEvent, handler: EventHandler<ProviderEvents | ClientProviderEvents>): void;
        emit(eventType: E, context?: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>): void;
        getHandlers(eventType: AnyProviderEvent): EventHandler<ProviderEvents | ClientProviderEvents>[];
        removeAllHandlers(eventType?: AnyProviderEvent): void;
        removeHandler(eventType: AnyProviderEvent, handler: EventHandler<ProviderEvents | ClientProviderEvents>): void;
        setLogger(logger: Logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    Methods

    +
    diff --git a/interfaces/_openfeature_server_sdk.ProviderMetadata.html b/interfaces/_openfeature_server_sdk.ProviderMetadata.html index 393de3c40..fc4be08d2 100644 --- a/interfaces/_openfeature_server_sdk.ProviderMetadata.html +++ b/interfaces/_openfeature_server_sdk.ProviderMetadata.html @@ -1,3 +1,3 @@ ProviderMetadata | Documentation

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    Properties

    name: string
    +
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    Properties

    name: string
    diff --git a/interfaces/_openfeature_server_sdk.Tracking.html b/interfaces/_openfeature_server_sdk.Tracking.html index 8037f7f44..ff5db8c9c 100644 --- a/interfaces/_openfeature_server_sdk.Tracking.html +++ b/interfaces/_openfeature_server_sdk.Tracking.html @@ -1,6 +1,6 @@ -Tracking | Documentation
    interface Tracking {
        track(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Methods

    track +Tracking | Documentation
    interface Tracking {
        track(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Methods

    Methods

    • Track a user action or application state, usually representing a business objective or outcome.

      Parameters

      • trackingEventName: string

        an identifier for the event

      • Optionalcontext: EvaluationContext

        the evaluation context

      • OptionaltrackingEventDetails: TrackingEventDetails

        the details of the tracking event

        -

      Returns void

    +

    Returns void

    diff --git a/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html b/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html index df4451085..cb6372375 100644 --- a/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html +++ b/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html @@ -1,9 +1,9 @@ -TransactionContextPropagator | Documentation
    interface TransactionContextPropagator {
        getTransactionContext(): EvaluationContext;
        setTransactionContext<TArgs, R>(transactionContext: EvaluationContext, callback: ((...args: TArgs) => R), ...args: TArgs): void;
    }

    Hierarchy (view full)

    Implemented by

    Methods

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

    Hierarchy (view full)

    Implemented by

    Methods

    • 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,4 +18,4 @@

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

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

      Callback function to run

        • (...args): R
        • Parameters

          Returns R

    • Rest...args: TArgs

      Optional arguments that are passed to the callback function

      -

    Returns void

    +

    Returns void

    diff --git a/interfaces/_openfeature_web_sdk.BaseHook.html b/interfaces/_openfeature_web_sdk.BaseHook.html index 0e0f529e8..71050725b 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: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        before?(hookContext: BeforeHookContext, hookHints?: Readonly<Record<string, unknown>>): BeforeHookReturn;
        error?(hookContext: Readonly<HookContext<T>>, error: unknown, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        finally?(hookContext: Readonly<HookContext<T>>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    }

    Type Parameters

    Methods

    after? +BaseHook | Documentation

    Interface BaseHook<T, BeforeHookReturn, HooksReturn>

    interface BaseHook<T, BeforeHookReturn, HooksReturn> {
        after?(hookContext: Readonly<HookContext<T>>, evaluationDetails: EvaluationDetails<T>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        before?(hookContext: BeforeHookContext, hookHints?: Readonly<Record<string, unknown>>): BeforeHookReturn;
        error?(hookContext: Readonly<HookContext<T>>, error: unknown, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
        finally?(hookContext: Readonly<HookContext<T>>, hookHints?: Readonly<Record<string, unknown>>): HooksReturn;
    }

    Type Parameters

    Methods

    • 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>>
      • OptionalhookHints: Readonly<Record<string, unknown>>

      Returns HooksReturn

    +

    Parameters

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

    Returns HooksReturn

    diff --git a/interfaces/_openfeature_web_sdk.BeforeHookContext.html b/interfaces/_openfeature_web_sdk.BeforeHookContext.html index 11588b054..70264bd10 100644 --- a/interfaces/_openfeature_web_sdk.BeforeHookContext.html +++ b/interfaces/_openfeature_web_sdk.BeforeHookContext.html @@ -1,8 +1,8 @@ -BeforeHookContext | Documentation
    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 {
        clientMetadata: ClientMetadata;
        context: EvaluationContext;
        defaultValue: FlagValue;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Hierarchy (view full)

    Properties

    clientMetadata: ClientMetadata
    defaultValue: FlagValue
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    +

    Properties

    clientMetadata: ClientMetadata
    defaultValue: FlagValue
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    diff --git a/interfaces/_openfeature_web_sdk.Client.html b/interfaces/_openfeature_web_sdk.Client.html index 4275d06bb..f738c2a07 100644 --- a/interfaces/_openfeature_web_sdk.Client.html +++ b/interfaces/_openfeature_web_sdk.Client.html @@ -1,4 +1,4 @@ -Client | Documentation
    interface Client {
        metadata: ClientMetadata;
        providerStatus: ProviderStatus;
        addHandler(eventType: ConfigurationChanged, handler: EventHandler<ConfigurationChanged>): void;
        addHandler(eventType: ClientNotChangeEvents, handler: EventHandler<ClientNotChangeEvents>): void;
        addHandler(eventType: ProviderEvents, handler: EventHandler<ProviderEvents>): void;
        addHooks(...hooks: BaseHook<FlagValue, unknown, unknown>[]): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey: string, defaultValue: boolean, options?: FlagEvaluationOptions): EvaluationDetails<boolean>;
        getBooleanValue(flagKey: string, defaultValue: boolean, options?: FlagEvaluationOptions): boolean;
        getHandlers(eventType: ProviderEvents): EventHandler<ProviderEvents>[];
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
        getNumberDetails(flagKey: string, defaultValue: number, options?: FlagEvaluationOptions): EvaluationDetails<number>;
        getNumberDetails<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): EvaluationDetails<T>;
        getNumberValue(flagKey: string, defaultValue: number, options?: FlagEvaluationOptions): number;
        getNumberValue<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): T;
        getObjectDetails(flagKey: string, defaultValue: JsonValue, options?: FlagEvaluationOptions): EvaluationDetails<JsonValue>;
        getObjectDetails<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): EvaluationDetails<T>;
        getObjectValue(flagKey: string, defaultValue: JsonValue, options?: FlagEvaluationOptions): JsonValue;
        getObjectValue<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): T;
        getStringDetails(flagKey: string, defaultValue: string, options?: FlagEvaluationOptions): EvaluationDetails<string>;
        getStringDetails<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): EvaluationDetails<T>;
        getStringValue(flagKey: string, defaultValue: string, options?: FlagEvaluationOptions): string;
        getStringValue<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): T;
        removeHandler(eventType: ProviderEvents, handler: EventHandler<ProviderEvents>): void;
        setLogger(logger: Logger): Client;
        track(trackingEventName: string, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Properties

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

    Hierarchy (view full)

    Properties

    Methods

    Properties

    metadata: ClientMetadata
    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    -

    Methods

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

    Properties

    metadata: ClientMetadata
    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    +

    Methods

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

    Returns void

  • Parameters

    • eventType: ClientNotChangeEvents
    • handler: EventHandler<ClientNotChangeEvents>

    Returns void

  • Parameters

    Returns void

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

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

      • Optionaloptions: FlagEvaluationOptions

        Additional flag evaluation options

      Returns boolean

      Flag evaluation response

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

    Returns void

    +

    Returns void

    diff --git a/interfaces/_openfeature_web_sdk.ClientMetadata.html b/interfaces/_openfeature_web_sdk.ClientMetadata.html index ad38f54e6..232dbcf6d 100644 --- a/interfaces/_openfeature_web_sdk.ClientMetadata.html +++ b/interfaces/_openfeature_web_sdk.ClientMetadata.html @@ -1,6 +1,6 @@ -ClientMetadata | Documentation
    interface ClientMetadata {
        domain?: string;
        name?: string;
        providerMetadata: ProviderMetadata;
        version?: string;
    }

    Properties

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

    Properties

    domain?: string
    name?: string

    alias of "domain", use domain instead

    -
    providerMetadata: ProviderMetadata
    version?: string
    +

    Properties

    domain?: string
    name?: string

    alias of "domain", use domain instead

    +
    providerMetadata: ProviderMetadata
    version?: string
    diff --git a/interfaces/_openfeature_web_sdk.CommonProvider.html b/interfaces/_openfeature_web_sdk.CommonProvider.html index e007062c0..161262091 100644 --- a/interfaces/_openfeature_web_sdk.CommonProvider.html +++ b/interfaces/_openfeature_web_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation
    interface CommonProvider<S> {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: S;
        initialize?(context?: EvaluationContext): Promise<void>;
        onClose?(): Promise<void>;
        track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    events? +CommonProvider | Documentation
    interface CommonProvider<S> {
        events?: ProviderEventEmitter<AnyProviderEvent, Record<string, unknown>>;
        metadata: ProviderMetadata;
        runsOn?: Paradigm;
        status?: S;
        initialize?(context?: EvaluationContext): Promise<void>;
        onClose?(): Promise<void>;
        track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    Properties

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

    An event emitter for ProviderEvents.

    ProviderEvents

    -
    runsOn?: Paradigm

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

    runsOn?: Paradigm

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

    -
    status?: S

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

    status?: S

    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

    • A function used to setup the provider. +

    Methods

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

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

    +

    Returns Promise<void>

    diff --git a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html index fb876d372..9251b47c7 100644 --- a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html +++ b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html @@ -1,4 +1,4 @@ -EvaluationLifeCycle | Documentation
    interface EvaluationLifeCycle<T> {
        addHooks(...hooks: BaseHook<FlagValue, unknown, unknown>[]): T;
        clearHooks(): T;
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

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

      -
    +
    diff --git a/interfaces/_openfeature_web_sdk.Eventing.html b/interfaces/_openfeature_web_sdk.Eventing.html index 2719c5229..6bdde56e4 100644 --- a/interfaces/_openfeature_web_sdk.Eventing.html +++ b/interfaces/_openfeature_web_sdk.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation
    interface Eventing<T> {
        addHandler(eventType: T extends ProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged, handler: EventHandler<T extends ProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged>): void;
        addHandler(eventType: T extends ProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents, handler: EventHandler<T extends ProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents>): void;
        addHandler(eventType: T extends ProviderEvents
            ? ProviderEvents
            : ServerProviderEvents, handler: EventHandler<T extends ProviderEvents
            ? ProviderEvents
            : ServerProviderEvents>): void;
        getHandlers(eventType: T): EventHandler<T>[];
        removeHandler(eventType: T, handler: EventHandler<T>): void;
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +Eventing | Documentation
    interface Eventing<T> {
        addHandler(eventType: T extends ProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged, handler: EventHandler<T extends ProviderEvents
            ? ConfigurationChanged
            : ConfigurationChanged>): void;
        addHandler(eventType: T extends ProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents, handler: EventHandler<T extends ProviderEvents
            ? ClientNotChangeEvents
            : ServerNotChangeEvents>): void;
        addHandler(eventType: T extends ProviderEvents
            ? ProviderEvents
            : ServerProviderEvents, handler: EventHandler<T extends ProviderEvents
            ? ProviderEvents
            : ServerProviderEvents>): void;
        getHandlers(eventType: T): EventHandler<T>[];
        removeHandler(eventType: T, handler: EventHandler<T>): void;
    }

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

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

      +

    Returns void

  • Parameters

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

    Returns void

  • Parameters

    Returns 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

    +

    Returns void

    diff --git a/interfaces/_openfeature_web_sdk.Features.html b/interfaces/_openfeature_web_sdk.Features.html index 0ee40d266..144b9d240 100644 --- a/interfaces/_openfeature_web_sdk.Features.html +++ b/interfaces/_openfeature_web_sdk.Features.html @@ -1,4 +1,4 @@ -Features | Documentation
    interface Features {
        getBooleanDetails(flagKey: string, defaultValue: boolean, options?: FlagEvaluationOptions): EvaluationDetails<boolean>;
        getBooleanValue(flagKey: string, defaultValue: boolean, options?: FlagEvaluationOptions): boolean;
        getNumberDetails(flagKey: string, defaultValue: number, options?: FlagEvaluationOptions): EvaluationDetails<number>;
        getNumberDetails<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): EvaluationDetails<T>;
        getNumberValue(flagKey: string, defaultValue: number, options?: FlagEvaluationOptions): number;
        getNumberValue<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): T;
        getObjectDetails(flagKey: string, defaultValue: JsonValue, options?: FlagEvaluationOptions): EvaluationDetails<JsonValue>;
        getObjectDetails<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): EvaluationDetails<T>;
        getObjectValue(flagKey: string, defaultValue: JsonValue, options?: FlagEvaluationOptions): JsonValue;
        getObjectValue<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): T;
        getStringDetails(flagKey: string, defaultValue: string, options?: FlagEvaluationOptions): EvaluationDetails<string>;
        getStringDetails<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): EvaluationDetails<T>;
        getStringValue(flagKey: string, defaultValue: string, options?: FlagEvaluationOptions): string;
        getStringValue<T>(flagKey: string, defaultValue: T, options?: FlagEvaluationOptions): T;
    }

    Hierarchy (view full)

    Methods

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

    Hierarchy (view full)

    Methods

  • defaultValue: boolean

    The value returned if an error occurs

  • Optionaloptions: FlagEvaluationOptions

    Additional flag evaluation options

  • Returns EvaluationDetails<boolean>

    Flag evaluation details response

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

      • Optionaloptions: FlagEvaluationOptions

        Additional flag evaluation options

      Returns boolean

      Flag evaluation response

      -
    +
  • Type Parameters

    • T extends string = string

    Parameters

    Returns T

  • diff --git a/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html index 5d265e4b0..495d64275 100644 --- a/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html +++ b/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html @@ -1,3 +1,3 @@ -FlagEvaluationOptions | Documentation
    interface FlagEvaluationOptions {
        hookHints?: Readonly<Record<string, unknown>>;
        hooks?: BaseHook<FlagValue, unknown, unknown>[];
    }

    Properties

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

    Properties

    Properties

    hookHints?: Readonly<Record<string, unknown>>
    hooks?: BaseHook<FlagValue, unknown, unknown>[]
    +

    Properties

    hookHints?: Readonly<Record<string, unknown>>
    hooks?: BaseHook<FlagValue, unknown, unknown>[]
    diff --git a/interfaces/_openfeature_web_sdk.HookContext.html b/interfaces/_openfeature_web_sdk.HookContext.html index 0e5ba08b8..374253d16 100644 --- a/interfaces/_openfeature_web_sdk.HookContext.html +++ b/interfaces/_openfeature_web_sdk.HookContext.html @@ -1,8 +1,8 @@ -HookContext | Documentation
    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> {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata: ClientMetadata
    context: Readonly<EvaluationContext>
    defaultValue: T
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    +

    Properties

    clientMetadata: ClientMetadata
    context: Readonly<EvaluationContext>
    defaultValue: T
    flagKey: string
    flagValueType: FlagValueType
    logger: Logger
    providerMetadata: ProviderMetadata
    diff --git a/interfaces/_openfeature_web_sdk.Logger.html b/interfaces/_openfeature_web_sdk.Logger.html index 880aefa83..88bdff8d0 100644 --- a/interfaces/_openfeature_web_sdk.Logger.html +++ b/interfaces/_openfeature_web_sdk.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation
    interface Logger {
        debug(...args: unknown[]): void;
        error(...args: unknown[]): void;
        info(...args: unknown[]): void;
        warn(...args: unknown[]): void;
    }

    Implemented by

    Methods

    debug +Logger | Documentation
    interface Logger {
        debug(...args: unknown[]): void;
        error(...args: unknown[]): void;
        info(...args: unknown[]): void;
        warn(...args: unknown[]): void;
    }

    Implemented by

    Methods

    Methods

    +

    Methods

    diff --git a/interfaces/_openfeature_web_sdk.ManageContext.html b/interfaces/_openfeature_web_sdk.ManageContext.html index 132ba52a2..9973e0d8e 100644 --- a/interfaces/_openfeature_web_sdk.ManageContext.html +++ b/interfaces/_openfeature_web_sdk.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation
    interface ManageContext<T> {
        getContext(): EvaluationContext;
        setContext(context: EvaluationContext): T;
    }

    Type Parameters

    • T

    Implemented by

    Methods

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

    Type Parameters

    • T

    Implemented by

    Methods

    +
    diff --git a/interfaces/_openfeature_web_sdk.ManageLogger.html b/interfaces/_openfeature_web_sdk.ManageLogger.html index b1021f934..79144c650 100644 --- a/interfaces/_openfeature_web_sdk.ManageLogger.html +++ b/interfaces/_openfeature_web_sdk.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation
    interface ManageLogger<T> {
        setLogger(logger: Logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation
    interface ManageLogger<T> {
        setLogger(logger: Logger): T;
    }

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    Methods

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

      -
    +
    diff --git a/interfaces/_openfeature_web_sdk.Provider.html b/interfaces/_openfeature_web_sdk.Provider.html index 8355fea32..75227a0ef 100644 --- a/interfaces/_openfeature_web_sdk.Provider.html +++ b/interfaces/_openfeature_web_sdk.Provider.html @@ -1,7 +1,7 @@ Provider | Documentation

    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?: EvaluationContext): Promise<void>;
        onClose?(): Promise<void>;
        onContextChange?(oldContext: EvaluationContext, newContext: EvaluationContext): void | Promise<void>;
        resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): ResolutionDetails<boolean>;
        resolveNumberEvaluation(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): ResolutionDetails<number>;
        resolveObjectEvaluation<T>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): ResolutionDetails<T>;
        resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): ResolutionDetails<string>;
        track?(trackingEventName: string, context?: EvaluationContext, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Implemented by

    Properties

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

    Hierarchy (view full)

    Implemented by

    Properties

    events? hooks? metadata runsOn? @@ -16,31 +16,31 @@ track?

    Properties

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

    An event emitter for ProviderEvents.

    ProviderEvents

    -
    hooks?: Hook[]

    A provider hook exposes a mechanism for provider authors to register 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.

    -
    runsOn?: Paradigm

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

    runsOn?: Paradigm

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

    -

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

    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

    • A function used to setup the provider. +

    Methods

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

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

    +

    Parameters

    Returns void | Promise<void>

    diff --git a/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html b/interfaces/_openfeature_web_sdk.ProviderEventEmitter.html index 4a10968af..b90de23ac 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

    OpenFeatureEventEmitter.

    -
    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ProviderEvents>): void;
        emit(eventType: E, context?: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>): void;
        getHandlers(eventType: AnyProviderEvent): EventHandler<ServerProviderEvents | ProviderEvents>[];
        removeAllHandlers(eventType?: AnyProviderEvent): void;
        removeHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ProviderEvents>): void;
        setLogger(logger: Logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    interface ProviderEventEmitter<E, AdditionalContext> {
        addHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ProviderEvents>): void;
        emit(eventType: E, context?: EventContext<Record<string, unknown>, (ServerProviderEvents | ClientProviderEvents)>): void;
        getHandlers(eventType: AnyProviderEvent): EventHandler<ServerProviderEvents | ProviderEvents>[];
        removeAllHandlers(eventType?: AnyProviderEvent): void;
        removeHandler(eventType: AnyProviderEvent, handler: EventHandler<ServerProviderEvents | ProviderEvents>): void;
        setLogger(logger: Logger): ProviderEventEmitter<E, AdditionalContext>;
    }

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    Methods

    +
    diff --git a/interfaces/_openfeature_web_sdk.ProviderMetadata.html b/interfaces/_openfeature_web_sdk.ProviderMetadata.html index 3251e23fe..a3c41664a 100644 --- a/interfaces/_openfeature_web_sdk.ProviderMetadata.html +++ b/interfaces/_openfeature_web_sdk.ProviderMetadata.html @@ -1,3 +1,3 @@ ProviderMetadata | Documentation

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    Properties

    name: string
    +
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    Properties

    name: string
    diff --git a/interfaces/_openfeature_web_sdk.Tracking.html b/interfaces/_openfeature_web_sdk.Tracking.html index ec39b313d..c92a3beef 100644 --- a/interfaces/_openfeature_web_sdk.Tracking.html +++ b/interfaces/_openfeature_web_sdk.Tracking.html @@ -1,5 +1,5 @@ -Tracking | Documentation
    interface Tracking {
        track(trackingEventName: string, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Methods

    track +Tracking | Documentation
    interface Tracking {
        track(trackingEventName: string, trackingEventDetails?: TrackingEventDetails): void;
    }

    Hierarchy (view full)

    Methods

    Methods

    • Track a user action or application state, usually representing a business objective or outcome.

      Parameters

      • trackingEventName: string

        an identifier for the event

      • OptionaltrackingEventDetails: TrackingEventDetails

        the details of the tracking event

        -

      Returns void

    +

    Returns void

    diff --git a/media/README-3.md b/media/README-3.md index f344a3fa0..fb3d8d1a8 100644 --- a/media/README-3.md +++ b/media/README-3.md @@ -16,8 +16,8 @@ Specification - - Release + + Release
    @@ -233,14 +233,17 @@ function Page() { } ``` -Note that if your provider doesn't support updates, this configuration has no impact. +If your provider doesn't support updates, this configuration has no impact. + +> [!NOTE] +> If your provider includes a list of [flags changed](https://open-feature.github.io/js-sdk/types/_openfeature_server_sdk.ConfigChangeEvent.html) in its `PROVIDER_CONFIGURATION_CHANGED` event, that list of flags is used to decide which flag evaluation hooks should re-run by diffing the latest value of these flags with the previous render. +> If your provider event does not the include the `flags changed` list, then the SDK diffs all flags with the previous render to determine which hooks should re-run. #### Suspense Support > [!NOTE] > React suspense is an experimental feature and is subject to change in future versions. - Frequently, providers need to perform some initial startup tasks. It may be desirable not to display components with feature flags until this is complete or when the context changes. Built-in [suspense](https://react.dev/reference/react/Suspense) support makes this easy. diff --git a/types/_openfeature_core.AnyProviderEvent.html b/types/_openfeature_core.AnyProviderEvent.html index 41b993e80..2fbebc557 100644 --- a/types/_openfeature_core.AnyProviderEvent.html +++ b/types/_openfeature_core.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    A type representing any possible ProviderEvent (server or client side). In most cases, you probably want to import ProviderEvents from the respective SDK.

    -
    +
    diff --git a/types/_openfeature_core.CommonEventDetails.html b/types/_openfeature_core.CommonEventDetails.html index e7f1254db..073d1d0ab 100644 --- a/types/_openfeature_core.CommonEventDetails.html +++ b/types/_openfeature_core.CommonEventDetails.html @@ -1,2 +1,2 @@ CommonEventDetails | Documentation
    CommonEventDetails: {
        clientName?: string;
        domain?: string;
        providerName: string;
    }

    Type declaration

    • Optional ReadonlyclientName?: string

      alias of "domain", use domain instead

      -
    • Optional Readonlydomain?: string
    • ReadonlyproviderName: string
    +
  • Optional Readonlydomain?: string
  • ReadonlyproviderName: string
  • diff --git a/types/_openfeature_core.ConfigChangeEvent.html b/types/_openfeature_core.ConfigChangeEvent.html index 5ce473830..a3ea06576 100644 --- a/types/_openfeature_core.ConfigChangeEvent.html +++ b/types/_openfeature_core.ConfigChangeEvent.html @@ -1 +1 @@ -ConfigChangeEvent | Documentation
    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }
    +ConfigChangeEvent | Documentation
    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }
    diff --git a/types/_openfeature_core.ErrorEvent.html b/types/_openfeature_core.ErrorEvent.html index 54f8bbec4..8d9d9ac74 100644 --- a/types/_openfeature_core.ErrorEvent.html +++ b/types/_openfeature_core.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation
    ErrorEvent: CommonEventProps
    +ErrorEvent | Documentation
    ErrorEvent: CommonEventProps
    diff --git a/types/_openfeature_core.EvaluationContext.html b/types/_openfeature_core.EvaluationContext.html index ad2949181..79ecb9507 100644 --- a/types/_openfeature_core.EvaluationContext.html +++ b/types/_openfeature_core.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/types/_openfeature_core.EvaluationContextValue.html b/types/_openfeature_core.EvaluationContextValue.html index d2b02da6e..65ef365ec 100644 --- a/types/_openfeature_core.EvaluationContextValue.html +++ b/types/_openfeature_core.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation
    EvaluationContextValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: EvaluationContextValue;
        }
        | EvaluationContextValue[]
    +EvaluationContextValue | Documentation
    EvaluationContextValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: EvaluationContextValue;
        }
        | EvaluationContextValue[]
    diff --git a/types/_openfeature_core.EvaluationDetails.html b/types/_openfeature_core.EvaluationDetails.html index fbd3bcb9e..eb3b0ce35 100644 --- a/types/_openfeature_core.EvaluationDetails.html +++ b/types/_openfeature_core.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation
    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_core.EventContext.html b/types/_openfeature_core.EventContext.html index 8307cd0c7..eea2f7071 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

    +EventContext | Documentation

    Type Alias EventContext<U, T>

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

    Type Parameters

    diff --git a/types/_openfeature_core.EventDetails.html b/types/_openfeature_core.EventDetails.html index 5aed5f5c0..013ee09a2 100644 --- a/types/_openfeature_core.EventDetails.html +++ b/types/_openfeature_core.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation
    +EventDetails | Documentation
    diff --git a/types/_openfeature_core.EventHandler.html b/types/_openfeature_core.EventHandler.html index d12c95560..c940b65d4 100644 --- a/types/_openfeature_core.EventHandler.html +++ b/types/_openfeature_core.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation
    EventHandler<T>: ((eventDetails?: EventDetails<T>) => Promise<unknown> | unknown)

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_core.EventMetadata.html b/types/_openfeature_core.EventMetadata.html index 07c7d655f..ad34a377b 100644 --- a/types/_openfeature_core.EventMetadata.html +++ b/types/_openfeature_core.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation
    EventMetadata: {
        [key: string]: string | boolean | number;
    }
    +EventMetadata | Documentation
    EventMetadata: {
        [key: string]: string | boolean | number;
    }
    diff --git a/types/_openfeature_core.FlagMetadata.html b/types/_openfeature_core.FlagMetadata.html index 781d8536a..14e9deaeb 100644 --- a/types/_openfeature_core.FlagMetadata.html +++ b/types/_openfeature_core.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation
    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).

    -
    +
    diff --git a/types/_openfeature_core.FlagValue.html b/types/_openfeature_core.FlagValue.html index 3aba47948..c3d6c410b 100644 --- a/types/_openfeature_core.FlagValue.html +++ b/types/_openfeature_core.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation
    FlagValue:
        | boolean
        | string
        | number
        | JsonValue

    Represents a JSON node value, or Date.

    -
    +
    diff --git a/types/_openfeature_core.FlagValueType.html b/types/_openfeature_core.FlagValueType.html index 6cd9d08af..fd855d95a 100644 --- a/types/_openfeature_core.FlagValueType.html +++ b/types/_openfeature_core.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation
    FlagValueType:
        | "boolean"
        | "string"
        | "number"
        | "object"
    +FlagValueType | Documentation
    FlagValueType:
        | "boolean"
        | "string"
        | "number"
        | "object"
    diff --git a/types/_openfeature_core.HookHints.html b/types/_openfeature_core.HookHints.html index fff2d57ac..ab39819b2 100644 --- a/types/_openfeature_core.HookHints.html +++ b/types/_openfeature_core.HookHints.html @@ -1 +1 @@ -HookHints | Documentation
    HookHints: Readonly<Record<string, unknown>>
    +HookHints | Documentation
    HookHints: Readonly<Record<string, unknown>>
    diff --git a/types/_openfeature_core.JsonArray.html b/types/_openfeature_core.JsonArray.html index 8a5f5ea31..1e268da91 100644 --- a/types/_openfeature_core.JsonArray.html +++ b/types/_openfeature_core.JsonArray.html @@ -1 +1 @@ -JsonArray | Documentation
    +JsonArray | Documentation
    diff --git a/types/_openfeature_core.JsonObject.html b/types/_openfeature_core.JsonObject.html index 913f0f55c..cb1aabb28 100644 --- a/types/_openfeature_core.JsonObject.html +++ b/types/_openfeature_core.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation
    JsonObject: {
        [key: string]: JsonValue;
    }
    +JsonObject | Documentation
    JsonObject: {
        [key: string]: JsonValue;
    }
    diff --git a/types/_openfeature_core.JsonValue.html b/types/_openfeature_core.JsonValue.html index 2ea79b240..ed64b5219 100644 --- a/types/_openfeature_core.JsonValue.html +++ b/types/_openfeature_core.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Represents a JSON node value.

    -
    +
    diff --git a/types/_openfeature_core.Metadata.html b/types/_openfeature_core.Metadata.html index de7d66584..3c8b4f584 100644 --- a/types/_openfeature_core.Metadata.html +++ b/types/_openfeature_core.Metadata.html @@ -1 +1 @@ -Metadata | Documentation
    Metadata: Record<string, string>
    +Metadata | Documentation
    Metadata: Record<string, string>
    diff --git a/types/_openfeature_core.NotChangeEvents.html b/types/_openfeature_core.NotChangeEvents.html index 6d80b8906..8f15e2b87 100644 --- a/types/_openfeature_core.NotChangeEvents.html +++ b/types/_openfeature_core.NotChangeEvents.html @@ -1 +1 @@ -NotChangeEvents | Documentation
    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents
    +NotChangeEvents | Documentation
    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents
    diff --git a/types/_openfeature_core.Paradigm.html b/types/_openfeature_core.Paradigm.html index ec817018f..0c507436c 100644 --- a/types/_openfeature_core.Paradigm.html +++ b/types/_openfeature_core.Paradigm.html @@ -1,2 +1,2 @@ Paradigm | Documentation
    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -
    +
    diff --git a/types/_openfeature_core.PrimitiveValue.html b/types/_openfeature_core.PrimitiveValue.html index 6ed54791f..620000998 100644 --- a/types/_openfeature_core.PrimitiveValue.html +++ b/types/_openfeature_core.PrimitiveValue.html @@ -1 +1 @@ -PrimitiveValue | Documentation
    PrimitiveValue:
        | null
        | boolean
        | string
        | number
    +PrimitiveValue | Documentation
    PrimitiveValue:
        | null
        | boolean
        | string
        | number
    diff --git a/types/_openfeature_core.ReadyEvent.html b/types/_openfeature_core.ReadyEvent.html index 1130050c0..7e77f43c1 100644 --- a/types/_openfeature_core.ReadyEvent.html +++ b/types/_openfeature_core.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation
    ReadyEvent: CommonEventProps
    +ReadyEvent | Documentation
    ReadyEvent: CommonEventProps
    diff --git a/types/_openfeature_core.ReconcilingEvent.html b/types/_openfeature_core.ReconcilingEvent.html index f21c71a6f..2d4ad5937 100644 --- a/types/_openfeature_core.ReconcilingEvent.html +++ b/types/_openfeature_core.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation
    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }
    +ReconcilingEvent | Documentation
    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }
    diff --git a/types/_openfeature_core.ResolutionDetails.html b/types/_openfeature_core.ResolutionDetails.html index c1616f681..7507d4657 100644 --- a/types/_openfeature_core.ResolutionDetails.html +++ b/types/_openfeature_core.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation
    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

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

    Type Parameters

    • U
    diff --git a/types/_openfeature_core.ResolutionReason.html b/types/_openfeature_core.ResolutionReason.html index 16fe715a7..d9f4acfcf 100644 --- a/types/_openfeature_core.ResolutionReason.html +++ b/types/_openfeature_core.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation
    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>
    +ResolutionReason | Documentation
    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>
    diff --git a/types/_openfeature_core.StaleEvent.html b/types/_openfeature_core.StaleEvent.html index ecbfef4d8..09a9bdded 100644 --- a/types/_openfeature_core.StaleEvent.html +++ b/types/_openfeature_core.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation
    StaleEvent: CommonEventProps
    +StaleEvent | Documentation
    StaleEvent: CommonEventProps
    diff --git a/types/_openfeature_core.TrackingEventDetails.html b/types/_openfeature_core.TrackingEventDetails.html index f9a1122b9..3ae70be52 100644 --- a/types/_openfeature_core.TrackingEventDetails.html +++ b/types/_openfeature_core.TrackingEventDetails.html @@ -1,3 +1,3 @@ TrackingEventDetails | Documentation
    TrackingEventDetails: {
        value?: number;
    } & Record<string, TrackingEventValue>

    A container for arbitrary data that can relevant to tracking events.

    Type declaration

    • Optionalvalue?: number

      A numeric value associated with this event.

      -
    +
    diff --git a/types/_openfeature_core.TrackingEventValue.html b/types/_openfeature_core.TrackingEventValue.html index 1fc237ac8..00efb2bdd 100644 --- a/types/_openfeature_core.TrackingEventValue.html +++ b/types/_openfeature_core.TrackingEventValue.html @@ -1 +1 @@ -TrackingEventValue | Documentation
    TrackingEventValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: TrackingEventValue;
        }
        | TrackingEventValue[]
    +TrackingEventValue | Documentation
    TrackingEventValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: TrackingEventValue;
        }
        | TrackingEventValue[]
    diff --git a/types/_openfeature_server_sdk.AnyProviderEvent.html b/types/_openfeature_server_sdk.AnyProviderEvent.html index 7690a578e..1691e19c4 100644 --- a/types/_openfeature_server_sdk.AnyProviderEvent.html +++ b/types/_openfeature_server_sdk.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    A type representing any possible ProviderEvent (server or client side). In most cases, you probably want to import ProviderEvents from the respective SDK.

    -
    +
    diff --git a/types/_openfeature_server_sdk.CommonEventDetails.html b/types/_openfeature_server_sdk.CommonEventDetails.html index 2b027cc1f..0324b2442 100644 --- a/types/_openfeature_server_sdk.CommonEventDetails.html +++ b/types/_openfeature_server_sdk.CommonEventDetails.html @@ -1,2 +1,2 @@ CommonEventDetails | Documentation
    CommonEventDetails: {
        clientName?: string;
        domain?: string;
        providerName: string;
    }

    Type declaration

    • Optional ReadonlyclientName?: string

      alias of "domain", use domain instead

      -
    • Optional Readonlydomain?: string
    • ReadonlyproviderName: string
    +
  • Optional Readonlydomain?: string
  • ReadonlyproviderName: string
  • diff --git a/types/_openfeature_server_sdk.ConfigChangeEvent.html b/types/_openfeature_server_sdk.ConfigChangeEvent.html index 48939dc18..376e1f8ef 100644 --- a/types/_openfeature_server_sdk.ConfigChangeEvent.html +++ b/types/_openfeature_server_sdk.ConfigChangeEvent.html @@ -1 +1 @@ -ConfigChangeEvent | Documentation
    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }
    +ConfigChangeEvent | Documentation
    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }
    diff --git a/types/_openfeature_server_sdk.ErrorEvent.html b/types/_openfeature_server_sdk.ErrorEvent.html index c4e4eeca4..ca6822529 100644 --- a/types/_openfeature_server_sdk.ErrorEvent.html +++ b/types/_openfeature_server_sdk.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation
    ErrorEvent: CommonEventProps
    +ErrorEvent | Documentation
    ErrorEvent: CommonEventProps
    diff --git a/types/_openfeature_server_sdk.EvaluationContext.html b/types/_openfeature_server_sdk.EvaluationContext.html index b655007b3..07ab0b621 100644 --- a/types/_openfeature_server_sdk.EvaluationContext.html +++ b/types/_openfeature_server_sdk.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/types/_openfeature_server_sdk.EvaluationContextValue.html b/types/_openfeature_server_sdk.EvaluationContextValue.html index 4bd890a7f..539df66ad 100644 --- a/types/_openfeature_server_sdk.EvaluationContextValue.html +++ b/types/_openfeature_server_sdk.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation
    EvaluationContextValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: EvaluationContextValue;
        }
        | EvaluationContextValue[]
    +EvaluationContextValue | Documentation
    EvaluationContextValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: EvaluationContextValue;
        }
        | EvaluationContextValue[]
    diff --git a/types/_openfeature_server_sdk.EvaluationDetails.html b/types/_openfeature_server_sdk.EvaluationDetails.html index e595a6e28..8f3fb9a8c 100644 --- a/types/_openfeature_server_sdk.EvaluationDetails.html +++ b/types/_openfeature_server_sdk.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation
    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_server_sdk.EventContext.html b/types/_openfeature_server_sdk.EventContext.html index 06176c3cf..6c791f66a 100644 --- a/types/_openfeature_server_sdk.EventContext.html +++ b/types/_openfeature_server_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation
    EventContext<U, T>: (T extends ClientProviderEvents
        ? ClientEventMap[T]
        : T extends ProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_server_sdk.EventDetails.html b/types/_openfeature_server_sdk.EventDetails.html index cfda6c2cd..f183dad14 100644 --- a/types/_openfeature_server_sdk.EventDetails.html +++ b/types/_openfeature_server_sdk.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation
    +EventDetails | Documentation
    diff --git a/types/_openfeature_server_sdk.EventHandler.html b/types/_openfeature_server_sdk.EventHandler.html index bc21273f5..f72cad972 100644 --- a/types/_openfeature_server_sdk.EventHandler.html +++ b/types/_openfeature_server_sdk.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation
    EventHandler<T>: ((eventDetails?: EventDetails<T>) => Promise<unknown> | unknown)

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_server_sdk.EventMetadata.html b/types/_openfeature_server_sdk.EventMetadata.html index 99a5f7690..732c53709 100644 --- a/types/_openfeature_server_sdk.EventMetadata.html +++ b/types/_openfeature_server_sdk.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation
    EventMetadata: {
        [key: string]: string | boolean | number;
    }
    +EventMetadata | Documentation
    EventMetadata: {
        [key: string]: string | boolean | number;
    }
    diff --git a/types/_openfeature_server_sdk.FlagMetadata.html b/types/_openfeature_server_sdk.FlagMetadata.html index 5200176b7..034abc5fa 100644 --- a/types/_openfeature_server_sdk.FlagMetadata.html +++ b/types/_openfeature_server_sdk.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation
    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).

    -
    +
    diff --git a/types/_openfeature_server_sdk.FlagValue.html b/types/_openfeature_server_sdk.FlagValue.html index 11177a85a..a6ecf82c8 100644 --- a/types/_openfeature_server_sdk.FlagValue.html +++ b/types/_openfeature_server_sdk.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation
    FlagValue:
        | boolean
        | string
        | number
        | JsonValue

    Represents a JSON node value, or Date.

    -
    +
    diff --git a/types/_openfeature_server_sdk.FlagValueType.html b/types/_openfeature_server_sdk.FlagValueType.html index 163595fb2..f5a7250d5 100644 --- a/types/_openfeature_server_sdk.FlagValueType.html +++ b/types/_openfeature_server_sdk.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation
    FlagValueType:
        | "boolean"
        | "string"
        | "number"
        | "object"
    +FlagValueType | Documentation
    FlagValueType:
        | "boolean"
        | "string"
        | "number"
        | "object"
    diff --git a/types/_openfeature_server_sdk.Hook.html b/types/_openfeature_server_sdk.Hook.html index c0a579215..051c17815 100644 --- a/types/_openfeature_server_sdk.Hook.html +++ b/types/_openfeature_server_sdk.Hook.html @@ -1 +1 @@ -Hook | Documentation
    Hook: BaseHook<FlagValue, Promise<EvaluationContext | void> | EvaluationContext | void, Promise<void> | void>
    +Hook | Documentation
    Hook: BaseHook<FlagValue, Promise<EvaluationContext | void> | EvaluationContext | void, Promise<void> | void>
    diff --git a/types/_openfeature_server_sdk.HookHints.html b/types/_openfeature_server_sdk.HookHints.html index dca53ca79..cb7d5ccee 100644 --- a/types/_openfeature_server_sdk.HookHints.html +++ b/types/_openfeature_server_sdk.HookHints.html @@ -1 +1 @@ -HookHints | Documentation
    HookHints: Readonly<Record<string, unknown>>
    +HookHints | Documentation
    HookHints: Readonly<Record<string, unknown>>
    diff --git a/types/_openfeature_server_sdk.JsonArray.html b/types/_openfeature_server_sdk.JsonArray.html index b23745767..cf4edd6e8 100644 --- a/types/_openfeature_server_sdk.JsonArray.html +++ b/types/_openfeature_server_sdk.JsonArray.html @@ -1 +1 @@ -JsonArray | Documentation
    +JsonArray | Documentation
    diff --git a/types/_openfeature_server_sdk.JsonObject.html b/types/_openfeature_server_sdk.JsonObject.html index 9f8574712..dec20a4e4 100644 --- a/types/_openfeature_server_sdk.JsonObject.html +++ b/types/_openfeature_server_sdk.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation
    JsonObject: {
        [key: string]: JsonValue;
    }
    +JsonObject | Documentation
    JsonObject: {
        [key: string]: JsonValue;
    }
    diff --git a/types/_openfeature_server_sdk.JsonValue.html b/types/_openfeature_server_sdk.JsonValue.html index 054b36f66..f8936e8c1 100644 --- a/types/_openfeature_server_sdk.JsonValue.html +++ b/types/_openfeature_server_sdk.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Represents a JSON node value.

    -
    +
    diff --git a/types/_openfeature_server_sdk.Metadata.html b/types/_openfeature_server_sdk.Metadata.html index dd9cf3d14..5fec269f2 100644 --- a/types/_openfeature_server_sdk.Metadata.html +++ b/types/_openfeature_server_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation
    Metadata: Record<string, string>
    +Metadata | Documentation
    Metadata: Record<string, string>
    diff --git a/types/_openfeature_server_sdk.NotChangeEvents.html b/types/_openfeature_server_sdk.NotChangeEvents.html index 4df68288a..827fcffca 100644 --- a/types/_openfeature_server_sdk.NotChangeEvents.html +++ b/types/_openfeature_server_sdk.NotChangeEvents.html @@ -1 +1 @@ -NotChangeEvents | Documentation
    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents
    +NotChangeEvents | Documentation
    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents
    diff --git a/types/_openfeature_server_sdk.Paradigm.html b/types/_openfeature_server_sdk.Paradigm.html index 74c794d95..e1f85cc77 100644 --- a/types/_openfeature_server_sdk.Paradigm.html +++ b/types/_openfeature_server_sdk.Paradigm.html @@ -1,2 +1,2 @@ Paradigm | Documentation
    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -
    +
    diff --git a/types/_openfeature_server_sdk.PrimitiveValue.html b/types/_openfeature_server_sdk.PrimitiveValue.html index 390714c09..8c26e84fc 100644 --- a/types/_openfeature_server_sdk.PrimitiveValue.html +++ b/types/_openfeature_server_sdk.PrimitiveValue.html @@ -1 +1 @@ -PrimitiveValue | Documentation
    PrimitiveValue:
        | null
        | boolean
        | string
        | number
    +PrimitiveValue | Documentation
    PrimitiveValue:
        | null
        | boolean
        | string
        | number
    diff --git a/types/_openfeature_server_sdk.ReadyEvent.html b/types/_openfeature_server_sdk.ReadyEvent.html index 00e22c3d8..2a5c177ea 100644 --- a/types/_openfeature_server_sdk.ReadyEvent.html +++ b/types/_openfeature_server_sdk.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation
    ReadyEvent: CommonEventProps
    +ReadyEvent | Documentation
    ReadyEvent: CommonEventProps
    diff --git a/types/_openfeature_server_sdk.ReconcilingEvent.html b/types/_openfeature_server_sdk.ReconcilingEvent.html index 463cf6202..2cdae61a1 100644 --- a/types/_openfeature_server_sdk.ReconcilingEvent.html +++ b/types/_openfeature_server_sdk.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation
    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }
    +ReconcilingEvent | Documentation
    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }
    diff --git a/types/_openfeature_server_sdk.ResolutionDetails.html b/types/_openfeature_server_sdk.ResolutionDetails.html index 6f7424f64..58ca21ef3 100644 --- a/types/_openfeature_server_sdk.ResolutionDetails.html +++ b/types/_openfeature_server_sdk.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation
    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

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

    Type Parameters

    • U
    diff --git a/types/_openfeature_server_sdk.ResolutionReason.html b/types/_openfeature_server_sdk.ResolutionReason.html index cc9975486..6df69323b 100644 --- a/types/_openfeature_server_sdk.ResolutionReason.html +++ b/types/_openfeature_server_sdk.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation
    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>
    +ResolutionReason | Documentation
    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>
    diff --git a/types/_openfeature_server_sdk.StaleEvent.html b/types/_openfeature_server_sdk.StaleEvent.html index 51c541b51..15a233f75 100644 --- a/types/_openfeature_server_sdk.StaleEvent.html +++ b/types/_openfeature_server_sdk.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation
    StaleEvent: CommonEventProps
    +StaleEvent | Documentation
    StaleEvent: CommonEventProps
    diff --git a/types/_openfeature_server_sdk.TrackingEventDetails.html b/types/_openfeature_server_sdk.TrackingEventDetails.html index e52356af8..6751cfacd 100644 --- a/types/_openfeature_server_sdk.TrackingEventDetails.html +++ b/types/_openfeature_server_sdk.TrackingEventDetails.html @@ -1,3 +1,3 @@ TrackingEventDetails | Documentation
    TrackingEventDetails: {
        value?: number;
    } & Record<string, TrackingEventValue>

    A container for arbitrary data that can relevant to tracking events.

    Type declaration

    • Optionalvalue?: number

      A numeric value associated with this event.

      -
    +
    diff --git a/types/_openfeature_server_sdk.TrackingEventValue.html b/types/_openfeature_server_sdk.TrackingEventValue.html index 2eeeb310b..229b10971 100644 --- a/types/_openfeature_server_sdk.TrackingEventValue.html +++ b/types/_openfeature_server_sdk.TrackingEventValue.html @@ -1 +1 @@ -TrackingEventValue | Documentation
    TrackingEventValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: TrackingEventValue;
        }
        | TrackingEventValue[]
    +TrackingEventValue | Documentation
    TrackingEventValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: TrackingEventValue;
        }
        | TrackingEventValue[]
    diff --git a/types/_openfeature_server_sdk.TransactionContext.html b/types/_openfeature_server_sdk.TransactionContext.html index 40e73146c..31f054b5b 100644 --- a/types/_openfeature_server_sdk.TransactionContext.html +++ b/types/_openfeature_server_sdk.TransactionContext.html @@ -1,4 +1,4 @@ TransactionContext | Documentation
    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.

    -
    +
    diff --git a/types/_openfeature_web_sdk.AnyProviderEvent.html b/types/_openfeature_web_sdk.AnyProviderEvent.html index 1e9d1b488..c9185127b 100644 --- a/types/_openfeature_web_sdk.AnyProviderEvent.html +++ b/types/_openfeature_web_sdk.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    A type representing any possible ProviderEvent (server or client side). In most cases, you probably want to import ProviderEvents from the respective SDK.

    -
    +
    diff --git a/types/_openfeature_web_sdk.CommonEventDetails.html b/types/_openfeature_web_sdk.CommonEventDetails.html index 38832ec89..ca2d0fa69 100644 --- a/types/_openfeature_web_sdk.CommonEventDetails.html +++ b/types/_openfeature_web_sdk.CommonEventDetails.html @@ -1,2 +1,2 @@ CommonEventDetails | Documentation
    CommonEventDetails: {
        clientName?: string;
        domain?: string;
        providerName: string;
    }

    Type declaration

    • Optional ReadonlyclientName?: string

      alias of "domain", use domain instead

      -
    • Optional Readonlydomain?: string
    • ReadonlyproviderName: string
    +
  • Optional Readonlydomain?: string
  • ReadonlyproviderName: string
  • diff --git a/types/_openfeature_web_sdk.ConfigChangeEvent.html b/types/_openfeature_web_sdk.ConfigChangeEvent.html index 563712903..619a05c9d 100644 --- a/types/_openfeature_web_sdk.ConfigChangeEvent.html +++ b/types/_openfeature_web_sdk.ConfigChangeEvent.html @@ -1 +1 @@ -ConfigChangeEvent | Documentation
    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }
    +ConfigChangeEvent | Documentation
    ConfigChangeEvent: CommonEventProps & {
        flagsChanged?: string[];
    }
    diff --git a/types/_openfeature_web_sdk.ErrorEvent.html b/types/_openfeature_web_sdk.ErrorEvent.html index 488665cc8..613fd6c16 100644 --- a/types/_openfeature_web_sdk.ErrorEvent.html +++ b/types/_openfeature_web_sdk.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation
    ErrorEvent: CommonEventProps
    +ErrorEvent | Documentation
    ErrorEvent: CommonEventProps
    diff --git a/types/_openfeature_web_sdk.EvaluationContext.html b/types/_openfeature_web_sdk.EvaluationContext.html index f78e6d48c..629d1d549 100644 --- a/types/_openfeature_web_sdk.EvaluationContext.html +++ b/types/_openfeature_web_sdk.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    +
    diff --git a/types/_openfeature_web_sdk.EvaluationContextValue.html b/types/_openfeature_web_sdk.EvaluationContextValue.html index f2b4e1233..65ac46615 100644 --- a/types/_openfeature_web_sdk.EvaluationContextValue.html +++ b/types/_openfeature_web_sdk.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation
    EvaluationContextValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: EvaluationContextValue;
        }
        | EvaluationContextValue[]
    +EvaluationContextValue | Documentation
    EvaluationContextValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: EvaluationContextValue;
        }
        | EvaluationContextValue[]
    diff --git a/types/_openfeature_web_sdk.EvaluationDetails.html b/types/_openfeature_web_sdk.EvaluationDetails.html index 0dc0a83f9..1cc0d344e 100644 --- a/types/_openfeature_web_sdk.EvaluationDetails.html +++ b/types/_openfeature_web_sdk.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation
    EvaluationDetails<T>: {
        flagKey: string;
        flagMetadata: Readonly<FlagMetadata>;
    } & ResolutionDetails<T>

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_web_sdk.EventContext.html b/types/_openfeature_web_sdk.EventContext.html index 6cba17b00..baeea19fc 100644 --- a/types/_openfeature_web_sdk.EventContext.html +++ b/types/_openfeature_web_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation
    EventContext<U, T>: (T extends ProviderEvents
        ? ClientEventMap[T]
        : T extends ServerProviderEvents
            ? ServerEventMap[T]
            : never) & U

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_web_sdk.EventDetails.html b/types/_openfeature_web_sdk.EventDetails.html index 7f31683a8..24d1e49e9 100644 --- a/types/_openfeature_web_sdk.EventDetails.html +++ b/types/_openfeature_web_sdk.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation
    +EventDetails | Documentation
    diff --git a/types/_openfeature_web_sdk.EventHandler.html b/types/_openfeature_web_sdk.EventHandler.html index ae2d837ec..aecd244fb 100644 --- a/types/_openfeature_web_sdk.EventHandler.html +++ b/types/_openfeature_web_sdk.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation
    EventHandler<T>: ((eventDetails?: EventDetails<T>) => Promise<unknown> | unknown)

    Type Parameters

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

    Type Parameters

    diff --git a/types/_openfeature_web_sdk.EventMetadata.html b/types/_openfeature_web_sdk.EventMetadata.html index d8c4eead6..b84aa984f 100644 --- a/types/_openfeature_web_sdk.EventMetadata.html +++ b/types/_openfeature_web_sdk.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation
    EventMetadata: {
        [key: string]: string | boolean | number;
    }
    +EventMetadata | Documentation
    EventMetadata: {
        [key: string]: string | boolean | number;
    }
    diff --git a/types/_openfeature_web_sdk.FlagMetadata.html b/types/_openfeature_web_sdk.FlagMetadata.html index de21736f5..4ff3ad6a9 100644 --- a/types/_openfeature_web_sdk.FlagMetadata.html +++ b/types/_openfeature_web_sdk.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation
    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).

    -
    +
    diff --git a/types/_openfeature_web_sdk.FlagValue.html b/types/_openfeature_web_sdk.FlagValue.html index 04ebaf87d..d8da5215d 100644 --- a/types/_openfeature_web_sdk.FlagValue.html +++ b/types/_openfeature_web_sdk.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation
    FlagValue:
        | boolean
        | string
        | number
        | JsonValue

    Represents a JSON node value, or Date.

    -
    +
    diff --git a/types/_openfeature_web_sdk.FlagValueType.html b/types/_openfeature_web_sdk.FlagValueType.html index d53300bea..ae98328f3 100644 --- a/types/_openfeature_web_sdk.FlagValueType.html +++ b/types/_openfeature_web_sdk.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation
    FlagValueType:
        | "boolean"
        | "string"
        | "number"
        | "object"
    +FlagValueType | Documentation
    FlagValueType:
        | "boolean"
        | "string"
        | "number"
        | "object"
    diff --git a/types/_openfeature_web_sdk.Hook.html b/types/_openfeature_web_sdk.Hook.html index 192ed341e..ed63a29a6 100644 --- a/types/_openfeature_web_sdk.Hook.html +++ b/types/_openfeature_web_sdk.Hook.html @@ -1 +1 @@ -Hook | Documentation
    +Hook | Documentation
    diff --git a/types/_openfeature_web_sdk.HookHints.html b/types/_openfeature_web_sdk.HookHints.html index ffce8fdd8..13290f9ec 100644 --- a/types/_openfeature_web_sdk.HookHints.html +++ b/types/_openfeature_web_sdk.HookHints.html @@ -1 +1 @@ -HookHints | Documentation
    HookHints: Readonly<Record<string, unknown>>
    +HookHints | Documentation
    HookHints: Readonly<Record<string, unknown>>
    diff --git a/types/_openfeature_web_sdk.JsonArray.html b/types/_openfeature_web_sdk.JsonArray.html index 75425a17c..18636cbcf 100644 --- a/types/_openfeature_web_sdk.JsonArray.html +++ b/types/_openfeature_web_sdk.JsonArray.html @@ -1 +1 @@ -JsonArray | Documentation
    +JsonArray | Documentation
    diff --git a/types/_openfeature_web_sdk.JsonObject.html b/types/_openfeature_web_sdk.JsonObject.html index c8f7e3bad..d45fc05e4 100644 --- a/types/_openfeature_web_sdk.JsonObject.html +++ b/types/_openfeature_web_sdk.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation
    JsonObject: {
        [key: string]: JsonValue;
    }
    +JsonObject | Documentation
    JsonObject: {
        [key: string]: JsonValue;
    }
    diff --git a/types/_openfeature_web_sdk.JsonValue.html b/types/_openfeature_web_sdk.JsonValue.html index 0a2554a4d..5c2ee006c 100644 --- a/types/_openfeature_web_sdk.JsonValue.html +++ b/types/_openfeature_web_sdk.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Represents a JSON node value.

    -
    +
    diff --git a/types/_openfeature_web_sdk.Metadata.html b/types/_openfeature_web_sdk.Metadata.html index f1db883d8..0e98a8929 100644 --- a/types/_openfeature_web_sdk.Metadata.html +++ b/types/_openfeature_web_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation
    Metadata: Record<string, string>
    +Metadata | Documentation
    Metadata: Record<string, string>
    diff --git a/types/_openfeature_web_sdk.NotChangeEvents.html b/types/_openfeature_web_sdk.NotChangeEvents.html index 95632e8dc..a2cce0e10 100644 --- a/types/_openfeature_web_sdk.NotChangeEvents.html +++ b/types/_openfeature_web_sdk.NotChangeEvents.html @@ -1 +1 @@ -NotChangeEvents | Documentation
    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents
    +NotChangeEvents | Documentation
    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents
    diff --git a/types/_openfeature_web_sdk.Paradigm.html b/types/_openfeature_web_sdk.Paradigm.html index 27318bb4c..61fc812b0 100644 --- a/types/_openfeature_web_sdk.Paradigm.html +++ b/types/_openfeature_web_sdk.Paradigm.html @@ -1,2 +1,2 @@ Paradigm | Documentation
    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -
    +
    diff --git a/types/_openfeature_web_sdk.PrimitiveValue.html b/types/_openfeature_web_sdk.PrimitiveValue.html index e585b4d4b..1fff4f4a2 100644 --- a/types/_openfeature_web_sdk.PrimitiveValue.html +++ b/types/_openfeature_web_sdk.PrimitiveValue.html @@ -1 +1 @@ -PrimitiveValue | Documentation
    PrimitiveValue:
        | null
        | boolean
        | string
        | number
    +PrimitiveValue | Documentation
    PrimitiveValue:
        | null
        | boolean
        | string
        | number
    diff --git a/types/_openfeature_web_sdk.ProviderEmittableEvents.html b/types/_openfeature_web_sdk.ProviderEmittableEvents.html index 66d8175c8..4e65ae8e5 100644 --- a/types/_openfeature_web_sdk.ProviderEmittableEvents.html +++ b/types/_openfeature_web_sdk.ProviderEmittableEvents.html @@ -1,2 +1,2 @@ ProviderEmittableEvents | Documentation
    ProviderEmittableEvents: Exclude<ProviderEvents, ContextChanged>

    A subset of events that can be directly emitted by providers.

    -
    +
    diff --git a/types/_openfeature_web_sdk.ReadyEvent.html b/types/_openfeature_web_sdk.ReadyEvent.html index 392260267..3a7685c49 100644 --- a/types/_openfeature_web_sdk.ReadyEvent.html +++ b/types/_openfeature_web_sdk.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation
    ReadyEvent: CommonEventProps
    +ReadyEvent | Documentation
    ReadyEvent: CommonEventProps
    diff --git a/types/_openfeature_web_sdk.ReconcilingEvent.html b/types/_openfeature_web_sdk.ReconcilingEvent.html index 89a2fd46f..0aabf993d 100644 --- a/types/_openfeature_web_sdk.ReconcilingEvent.html +++ b/types/_openfeature_web_sdk.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation
    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }
    +ReconcilingEvent | Documentation
    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }
    diff --git a/types/_openfeature_web_sdk.ResolutionDetails.html b/types/_openfeature_web_sdk.ResolutionDetails.html index b8c25db28..16e635910 100644 --- a/types/_openfeature_web_sdk.ResolutionDetails.html +++ b/types/_openfeature_web_sdk.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation
    ResolutionDetails<U>: {
        errorCode?: ErrorCode;
        errorMessage?: string;
        flagMetadata?: FlagMetadata;
        reason?: ResolutionReason;
        value: U;
        variant?: string;
    }

    Type Parameters

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

    Type Parameters

    • U
    diff --git a/types/_openfeature_web_sdk.ResolutionReason.html b/types/_openfeature_web_sdk.ResolutionReason.html index 89585a819..41c68ba9b 100644 --- a/types/_openfeature_web_sdk.ResolutionReason.html +++ b/types/_openfeature_web_sdk.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation
    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>
    +ResolutionReason | Documentation
    ResolutionReason: keyof typeof StandardResolutionReasons | string & Record<never, never>
    diff --git a/types/_openfeature_web_sdk.StaleEvent.html b/types/_openfeature_web_sdk.StaleEvent.html index 9a66d4fad..15b653b3c 100644 --- a/types/_openfeature_web_sdk.StaleEvent.html +++ b/types/_openfeature_web_sdk.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation
    StaleEvent: CommonEventProps
    +StaleEvent | Documentation
    StaleEvent: CommonEventProps
    diff --git a/types/_openfeature_web_sdk.TrackingEventDetails.html b/types/_openfeature_web_sdk.TrackingEventDetails.html index 75e5069e8..cb0f6476e 100644 --- a/types/_openfeature_web_sdk.TrackingEventDetails.html +++ b/types/_openfeature_web_sdk.TrackingEventDetails.html @@ -1,3 +1,3 @@ TrackingEventDetails | Documentation
    TrackingEventDetails: {
        value?: number;
    } & Record<string, TrackingEventValue>

    A container for arbitrary data that can relevant to tracking events.

    Type declaration

    • Optionalvalue?: number

      A numeric value associated with this event.

      -
    +
    diff --git a/types/_openfeature_web_sdk.TrackingEventValue.html b/types/_openfeature_web_sdk.TrackingEventValue.html index 3323f09f1..059557fdf 100644 --- a/types/_openfeature_web_sdk.TrackingEventValue.html +++ b/types/_openfeature_web_sdk.TrackingEventValue.html @@ -1 +1 @@ -TrackingEventValue | Documentation
    TrackingEventValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: TrackingEventValue;
        }
        | TrackingEventValue[]
    +TrackingEventValue | Documentation
    TrackingEventValue:
        | PrimitiveValue
        | Date
        | {
            [key: string]: TrackingEventValue;
        }
        | TrackingEventValue[]
    diff --git a/variables/_openfeature_core.LOG_LEVELS.html b/variables/_openfeature_core.LOG_LEVELS.html index 55c5e7d17..4627ded95 100644 --- a/variables/_openfeature_core.LOG_LEVELS.html +++ b/variables/_openfeature_core.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation
    LOG_LEVELS: (keyof Logger)[] = ...
    +LOG_LEVELS | Documentation
    LOG_LEVELS: (keyof Logger)[] = ...
    diff --git a/variables/_openfeature_core.StandardResolutionReasons.html b/variables/_openfeature_core.StandardResolutionReasons.html index b09340865..8c61e2c5e 100644 --- a/variables/_openfeature_core.StandardResolutionReasons.html +++ b/variables/_openfeature_core.StandardResolutionReasons.html @@ -8,4 +8,4 @@
  • ReadonlySTATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • ReadonlyTARGETING_MATCH: "TARGETING_MATCH"

    The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.

  • ReadonlyUNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -
  • +
    diff --git a/variables/_openfeature_server_sdk.LOG_LEVELS.html b/variables/_openfeature_server_sdk.LOG_LEVELS.html index d96c52738..fb20efb38 100644 --- a/variables/_openfeature_server_sdk.LOG_LEVELS.html +++ b/variables/_openfeature_server_sdk.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation
    +LOG_LEVELS | Documentation
    diff --git a/variables/_openfeature_server_sdk.NOOP_PROVIDER.html b/variables/_openfeature_server_sdk.NOOP_PROVIDER.html index 94e0439b8..95b470474 100644 --- a/variables/_openfeature_server_sdk.NOOP_PROVIDER.html +++ b/variables/_openfeature_server_sdk.NOOP_PROVIDER.html @@ -1 +1 @@ -NOOP_PROVIDER | Documentation
    NOOP_PROVIDER: NoopFeatureProvider = ...
    +NOOP_PROVIDER | Documentation
    NOOP_PROVIDER: NoopFeatureProvider = ...
    diff --git a/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html b/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html index 4e56f43b7..d24b3e953 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 = ...
    +NOOP_TRANSACTION_CONTEXT_PROPAGATOR | Documentation

    Variable NOOP_TRANSACTION_CONTEXT_PROPAGATORConst

    NOOP_TRANSACTION_CONTEXT_PROPAGATOR: NoopTransactionContextPropagator = ...
    diff --git a/variables/_openfeature_server_sdk.OpenFeature.html b/variables/_openfeature_server_sdk.OpenFeature.html index 9b74f7dfd..50eaae463 100644 --- a/variables/_openfeature_server_sdk.OpenFeature.html +++ b/variables/_openfeature_server_sdk.OpenFeature.html @@ -1,3 +1,3 @@ OpenFeature | Documentation
    OpenFeature: OpenFeatureAPI = ...

    A singleton instance of the OpenFeature API.

    OpenFeature API

    -
    +
    diff --git a/variables/_openfeature_server_sdk.StandardResolutionReasons.html b/variables/_openfeature_server_sdk.StandardResolutionReasons.html index 32d2707fb..1d55a7f3c 100644 --- a/variables/_openfeature_server_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_server_sdk.StandardResolutionReasons.html @@ -8,4 +8,4 @@
  • ReadonlySTATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • ReadonlyTARGETING_MATCH: "TARGETING_MATCH"

    The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.

  • ReadonlyUNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -
  • +
    diff --git a/variables/_openfeature_web_sdk.LOG_LEVELS.html b/variables/_openfeature_web_sdk.LOG_LEVELS.html index 0183930dc..df6cdef7c 100644 --- a/variables/_openfeature_web_sdk.LOG_LEVELS.html +++ b/variables/_openfeature_web_sdk.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation
    LOG_LEVELS: (keyof Logger)[] = ...
    +LOG_LEVELS | Documentation
    LOG_LEVELS: (keyof Logger)[] = ...
    diff --git a/variables/_openfeature_web_sdk.NOOP_PROVIDER.html b/variables/_openfeature_web_sdk.NOOP_PROVIDER.html index 74665ab92..5d94feac4 100644 --- a/variables/_openfeature_web_sdk.NOOP_PROVIDER.html +++ b/variables/_openfeature_web_sdk.NOOP_PROVIDER.html @@ -1 +1 @@ -NOOP_PROVIDER | Documentation
    NOOP_PROVIDER: NoopFeatureProvider = ...
    +NOOP_PROVIDER | Documentation
    NOOP_PROVIDER: NoopFeatureProvider = ...
    diff --git a/variables/_openfeature_web_sdk.OpenFeature.html b/variables/_openfeature_web_sdk.OpenFeature.html index e50f07f2d..cf09b6d4d 100644 --- a/variables/_openfeature_web_sdk.OpenFeature.html +++ b/variables/_openfeature_web_sdk.OpenFeature.html @@ -1,3 +1,3 @@ OpenFeature | Documentation
    OpenFeature: OpenFeatureAPI = ...

    A singleton instance of the OpenFeature API.

    OpenFeature API

    -
    +
    diff --git a/variables/_openfeature_web_sdk.StandardResolutionReasons.html b/variables/_openfeature_web_sdk.StandardResolutionReasons.html index 930607e31..d6cf83a78 100644 --- a/variables/_openfeature_web_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_web_sdk.StandardResolutionReasons.html @@ -8,4 +8,4 @@
  • ReadonlySTATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • ReadonlyTARGETING_MATCH: "TARGETING_MATCH"

    The resolved value was the result of a dynamic evaluation, such as a rule or specific user-targeting.

  • ReadonlyUNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -
  • +