diff --git a/classes/_openfeature_core.DefaultLogger.html b/classes/_openfeature_core.DefaultLogger.html index 9646c0215..e80d3c9a9 100644 --- a/classes/_openfeature_core.DefaultLogger.html +++ b/classes/_openfeature_core.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor +DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor

Methods

debug error info warn -

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.FlagNotFoundError.html b/classes/_openfeature_core.FlagNotFoundError.html index 92432a57e..050b7ccb1 100644 --- a/classes/_openfeature_core.FlagNotFoundError.html +++ b/classes/_openfeature_core.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class GeneralError

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.GenericEventEmitter.html b/classes/_openfeature_core.GenericEventEmitter.html index d1c78535e..ca4276b03 100644 --- a/classes/_openfeature_core.GenericEventEmitter.html +++ b/classes/_openfeature_core.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

Class GenericEventEmitter<E, AdditionalContext>Abstract

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

-

Type Parameters

  • E extends AnyProviderEvent

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

Implements

Constructors

constructor +

Type Parameters

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

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

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

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

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

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

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

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    -

    Parameters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.InvalidContextError.html b/classes/_openfeature_core.InvalidContextError.html index d994d6231..3e96ffeb2 100644 --- a/classes/_openfeature_core.InvalidContextError.html +++ b/classes/_openfeature_core.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.OpenFeatureCommonAPI.html b/classes/_openfeature_core.OpenFeatureCommonAPI.html index fd1f557af..80e09d84a 100644 --- a/classes/_openfeature_core.OpenFeatureCommonAPI.html +++ b/classes/_openfeature_core.OpenFeatureCommonAPI.html @@ -1,4 +1,4 @@ -OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

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

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

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

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

addHooks

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

  • getProviderMetadata(domain?): ProviderMetadata

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

    -

    Parameters

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

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

  • Parameters

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

    Returns void | Promise<void>

setLogger

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

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

  • Parameters

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

    Returns void | Promise<void>

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger 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

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: P

        The provider responsible for flag evaluations.

      Returns this

      OpenFeature API

      -
    • setProvider(domain, provider): this

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

    • setProvider(domain, provider): this

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

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: P

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: P

          The provider responsible for flag evaluations.

        Returns this

        OpenFeature API

        -

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

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

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: P

        The provider responsible for flag evaluations.

      Returns Promise<void>

      Throws

      Uncaught exceptions thrown by the provider during initialization.

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

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

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

    • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: P

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: P

          The provider responsible for flag evaluations.

        Returns Promise<void>

        Throws

        Uncaught exceptions thrown by the provider during initialization.

        -

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.ParseError.html b/classes/_openfeature_core.ParseError.html index faa5d34ad..7ef2fd439 100644 --- a/classes/_openfeature_core.ParseError.html +++ b/classes/_openfeature_core.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.ProviderFatalError.html b/classes/_openfeature_core.ProviderFatalError.html index f493ac796..2ccd6db53 100644 --- a/classes/_openfeature_core.ProviderFatalError.html +++ b/classes/_openfeature_core.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.ProviderWrapper.html b/classes/_openfeature_core.ProviderWrapper.html index b901bec5e..50b85a5c5 100644 --- a/classes/_openfeature_core.ProviderWrapper.html +++ b/classes/_openfeature_core.ProviderWrapper.html @@ -1,6 +1,6 @@ ProviderWrapper | Documentation

Class ProviderWrapper<P, S>

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

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>

  • S extends AnyProviderStatus

Constructors

constructor +

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor

Properties

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

Methods

decrementPendingContextChanges incrementPendingContextChanges -

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.SafeLogger.html b/classes/_openfeature_core.SafeLogger.html index 02645e110..79f620f4e 100644 --- a/classes/_openfeature_core.SafeLogger.html +++ b/classes/_openfeature_core.SafeLogger.html @@ -1,4 +1,4 @@ -SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor +SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor

Properties

fallbackLogger logger

Methods

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

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_core.TypeMismatchError.html b/classes/_openfeature_core.TypeMismatchError.html index 0ae159e2d..4e1e472de 100644 --- a/classes/_openfeature_core.TypeMismatchError.html +++ b/classes/_openfeature_core.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class AsyncLocalStorageTransactionContextPropagator

Implements

Constructors

constructor +AsyncLocalStorageTransactionContextPropagator | Documentation

Class AsyncLocalStorageTransactionContextPropagator

Implements

Constructors

constructor

Properties

asyncLocalStorage

Methods

getTransactionContext setTransactionContext -

Constructors

constructor

Properties

Private asyncLocalStorage

asyncLocalStorage: AsyncLocalStorage<EvaluationContext> = ...

Methods

getTransactionContext

  • getTransactionContext(): EvaluationContext

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

Constructors

constructor

Properties

Private asyncLocalStorage

asyncLocalStorage: AsyncLocalStorage<EvaluationContext> = ...

Methods

getTransactionContext

setTransactionContext

setTransactionContext

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

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

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

    Example:

    app.use((req: Request, res: Response, next: NextFunction) => {
        const ip = res.headers.get("X-Forwarded-For")
        OpenFeature.setTransactionContext({ targetingKey: req.user.id, ipAddress: ip }, () => {
            // The transaction context is used in any flag evaluation throughout the whole call chain of next
            next();
        });
    })
    -

    Type Parameters

    • TArgs extends unknown[]

      The optional args passed to the callback function

      -

    • R

      The return value of the callback

      -

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

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

      Callback function to run

      -
        • (...args): R

        • Parameters

          Returns R

    • Rest ...args: TArgs

      Optional arguments that are passed to the callback function

      -

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Type Parameters

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.DefaultLogger.html b/classes/_openfeature_server_sdk.DefaultLogger.html index 99df0b228..251249fe3 100644 --- a/classes/_openfeature_server_sdk.DefaultLogger.html +++ b/classes/_openfeature_server_sdk.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor +DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor

Methods

debug error info warn -

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.GeneralError.html b/classes/_openfeature_server_sdk.GeneralError.html index 131468fe2..e2affdbbf 100644 --- a/classes/_openfeature_server_sdk.GeneralError.html +++ b/classes/_openfeature_server_sdk.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.GenericEventEmitter.html b/classes/_openfeature_server_sdk.GenericEventEmitter.html index c1b462040..110836e9c 100644 --- a/classes/_openfeature_server_sdk.GenericEventEmitter.html +++ b/classes/_openfeature_server_sdk.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

Class GenericEventEmitter<E, AdditionalContext>Abstract

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

-

Type Parameters

  • E extends AnyProviderEvent

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

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

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

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

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

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

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

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

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

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    -

    Parameters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.InMemoryProvider.html b/classes/_openfeature_server_sdk.InMemoryProvider.html index 2a76f4631..490da6fcf 100644 --- a/classes/_openfeature_server_sdk.InMemoryProvider.html +++ b/classes/_openfeature_server_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

Class InMemoryProvider

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

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

+

Constructors

constructor

Properties

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "server" = 'server'

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

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "server" = 'server'

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

-

Methods

Private lookupFlagValue

putConfiguration

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Methods

Private lookupFlagValue

putConfiguration

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_apiEmitter _clientEvents _context @@ -37,96 +37,96 @@ setProviderAndWait setTransactionContext setTransactionContextPropagator -

Constructors

Private constructor

Properties

Protected _apiEmitter

_apiEmitter: OpenFeatureEventEmitter = ...

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

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

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _apiEmitter

_apiEmitter: OpenFeatureEventEmitter = ...

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

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

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

Private allProviders

providerMetadata

Methods

Protected _createEventEmitter

addHandler

Methods

Protected _createEventEmitter

addHandler

addHooks

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

  • getClient(context?): Client

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

    All domainless or unbound clients use the default provider set via this.setProvider setProvider.

    -

    Parameters

    • Optional context: EvaluationContext

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

      +

      Parameters

      • Optional context: EvaluationContext

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

      Returns Client

      OpenFeature Client

      -
    • getClient(domain, context?): Client

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

    • getClient(domain, context?): Client

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

      If there is already a provider bound to this domain via this.setProvider setProvider, this provider will be used. Otherwise, the default provider is used until a provider is assigned to that domain.

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • Optional context: EvaluationContext

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

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • Optional context: EvaluationContext

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

        Returns Client

        OpenFeature Client

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

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

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

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

        If there is already a provider bound to this domain via this.setProvider setProvider, this provider will be used. Otherwise, the default provider is used until a provider is assigned to that domain.

        -

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          -
        • version: string

          The version of the client (only used for metadata)

          -
        • Optional context: EvaluationContext

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

          +

          Parameters

          • domain: string

            An identifier which logically binds clients with providers

            +
          • version: string

            The version of the client (only used for metadata)

            +
          • Optional context: EvaluationContext

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

          Returns Client

          OpenFeature Client

          -

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

Private getProviderStatus

getTransactionContext

Private getProviderStatus

getTransactionContext

removeHandler

setContext

removeHandler

setContext

setLogger

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    -

    Parameters

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

setProviderAndWait

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: Provider

        The provider responsible for flag evaluations.

      Returns Promise<void>

      Throws

      Uncaught exceptions thrown by the provider during initialization.

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

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

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

    • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: Provider

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: Provider

          The provider responsible for flag evaluations.

        Returns Promise<void>

        Throws

        Uncaught exceptions thrown by the provider during initialization.

        -

setTransactionContext

setTransactionContext

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

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

    The TransactionContextPropagator must persist the transactionContext and make it available @@ -135,14 +135,14 @@

    Example:

    app.use((req: Request, res: Response, next: NextFunction) => {
        const ip = res.headers.get("X-Forwarded-For")
        OpenFeature.setTransactionContext({ targetingKey: req.user.id, ipAddress: ip }, () => {
            // The transaction context is used in any flag evaluation throughout the whole call chain of next
            next();
        });
    })
    -

    Type Parameters

    • TArgs extends unknown[]

      The optional args passed to the callback function

      -

    • R

      The return value of the callback

      -

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

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

      Callback function to run

      -
        • (...args): R

        • Parameters

          Returns R

    • Rest ...args: TArgs

      Optional arguments that are passed to the callback function

      -

    Returns void

setTransactionContextPropagator

setTransactionContextPropagator

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureClient

Implements

Constructors

constructor +OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor

Properties

_clientLogger? _context _hooks @@ -34,86 +34,86 @@ removeHandler setContext setLogger -

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _context

_context: EvaluationContext

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Private Readonly providerStatusAccessor

providerStatusAccessor: (() => ProviderStatus)

Type declaration

Accessors

Private _logger

Private _provider

Private _providerStatus

metadata

providerStatus

Methods

addHandler

  • addHandler(eventType, handler): void

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

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _context

_context: EvaluationContext

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Private Readonly providerStatusAccessor

providerStatusAccessor: (() => ProviderStatus)

Type declaration

Accessors

Private _logger

Private _provider

Private _providerStatus

metadata

providerStatus

Methods

addHandler

addHooks

addHooks

  • addHooks(...hooks): OpenFeatureClient

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

Private afterHooks

Private beforeHooks

clearHooks

Private afterHooks

Private beforeHooks

clearHooks

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

getBooleanValue

getBooleanValue

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

  • Performs a flag evaluation that returns a boolean.

    +

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

      +
    • defaultValue: boolean

      The value returned if an error occurs

      +
    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

      +
    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<boolean>

    Flag evaluation response

    -

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

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

  • Performs a flag evaluation that returns a number.

    +

    Type Parameters

    • T extends number = number

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

      +
    • defaultValue: T

      The value returned if an error occurs

      +
    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

      +
    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<T>

    Flag evaluation response

    -

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

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

  • Performs a flag evaluation that returns a string.

    +

    Type Parameters

    • T extends string = string

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

      +
    • defaultValue: T

      The value returned if an error occurs

      +
    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

      +
    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<T>

    Flag evaluation response

    -

removeHandler

setContext

removeHandler

setContext

setLogger

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

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

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

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

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ClientProviderStatus | typeof ProviderStatus

Accessors

Private allProviders

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

addHooks

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

  • getProviderMetadata(domain?): ProviderMetadata

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

    -

    Parameters

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

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

  • Parameters

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

    Returns void | Promise<void>

setLogger

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

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

  • Parameters

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

    Returns void | Promise<void>

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger 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

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: P

        The provider responsible for flag evaluations.

      Returns this

      OpenFeature API

      -
    • setProvider(domain, provider): this

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

    • setProvider(domain, provider): this

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

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: P

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: P

          The provider responsible for flag evaluations.

        Returns this

        OpenFeature API

        -

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

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

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: P

        The provider responsible for flag evaluations.

      Returns Promise<void>

      Throws

      Uncaught exceptions thrown by the provider during initialization.

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

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

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

    • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: P

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: P

          The provider responsible for flag evaluations.

        Returns Promise<void>

        Throws

        Uncaught exceptions thrown by the provider during initialization.

        -

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html index dccd85da8..cbb33ecfd 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html +++ b/classes/_openfeature_server_sdk.OpenFeatureEventEmitter.html @@ -2,7 +2,7 @@ events at various parts of the provider lifecycle.

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

eventEmitter

Accessors

_logger

Methods

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

Constructors

constructor

Properties

Protected Readonly eventEmitter

eventEmitter: EventEmitter = ...

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

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

Constructors

constructor

Properties

Protected Readonly eventEmitter

eventEmitter: EventEmitter = ...

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class ParseError

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ProviderFatalError.html b/classes/_openfeature_server_sdk.ProviderFatalError.html index 6aad1aeda..57148dfd5 100644 --- a/classes/_openfeature_server_sdk.ProviderFatalError.html +++ b/classes/_openfeature_server_sdk.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ProviderNotReadyError.html b/classes/_openfeature_server_sdk.ProviderNotReadyError.html index 0288e4b0d..ec439c4e2 100644 --- a/classes/_openfeature_server_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_server_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_server_sdk.ProviderWrapper.html b/classes/_openfeature_server_sdk.ProviderWrapper.html index 130c83dca..f67c26853 100644 --- a/classes/_openfeature_server_sdk.ProviderWrapper.html +++ b/classes/_openfeature_server_sdk.ProviderWrapper.html @@ -1,6 +1,6 @@ ProviderWrapper | Documentation

Class ProviderWrapper<P, S>

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

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>

  • S extends AnyProviderStatus

Constructors

constructor +

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor

Properties

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

Methods

decrementPendingContextChanges incrementPendingContextChanges -

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class SafeLogger

Implements

Constructors

constructor +SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor

Properties

fallbackLogger logger

Methods

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

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.DefaultLogger.html b/classes/_openfeature_web_sdk.DefaultLogger.html index d2d809ae8..aa22014d0 100644 --- a/classes/_openfeature_web_sdk.DefaultLogger.html +++ b/classes/_openfeature_web_sdk.DefaultLogger.html @@ -1,6 +1,6 @@ -DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor +DefaultLogger | Documentation

Class DefaultLogger

Implements

Constructors

constructor

Methods

debug error info warn -

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.GeneralError.html b/classes/_openfeature_web_sdk.GeneralError.html index 412716068..164bef1f4 100644 --- a/classes/_openfeature_web_sdk.GeneralError.html +++ b/classes/_openfeature_web_sdk.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.GenericEventEmitter.html b/classes/_openfeature_web_sdk.GenericEventEmitter.html index 09edf4e98..9da1afeeb 100644 --- a/classes/_openfeature_web_sdk.GenericEventEmitter.html +++ b/classes/_openfeature_web_sdk.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

Class GenericEventEmitter<E, AdditionalContext>Abstract

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

-

Type Parameters

  • E extends AnyProviderEvent

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

Hierarchy (view full)

Implements

Constructors

constructor +

Type Parameters

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

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

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

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

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

Constructors

constructor

Properties

Private Optional _eventLogger

_eventLogger?: Logger

Private Readonly _handlers

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

Type declaration

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    -

    Parameters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.InMemoryProvider.html b/classes/_openfeature_web_sdk.InMemoryProvider.html index 5059f22ec..47c7d1a85 100644 --- a/classes/_openfeature_web_sdk.InMemoryProvider.html +++ b/classes/_openfeature_web_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

Class InMemoryProvider

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

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_context _flagConfiguration events @@ -14,19 +14,19 @@ resolveNumberEvaluation resolveObjectEvaluation resolveStringEvaluation -

Constructors

constructor

Properties

Private _context

_context: undefined | EvaluationContext

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

+

Constructors

constructor

Properties

Private _context

_context: undefined | EvaluationContext

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "client" = 'client'

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

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "client" = 'client'

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

-

Methods

initialize

Methods

initialize

  • initialize(context?): Promise<void>

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

    -

    Parameters

    Returns Promise<void>

Private lookupFlagValue

putConfiguration

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns Promise<void>

Private lookupFlagValue

putConfiguration

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.InvalidContextError.html b/classes/_openfeature_web_sdk.InvalidContextError.html index 888cc6275..34c9dd987 100644 --- a/classes/_openfeature_web_sdk.InvalidContextError.html +++ b/classes/_openfeature_web_sdk.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureAPI.html b/classes/_openfeature_web_sdk.OpenFeatureAPI.html index 15b193f36..09bf9e347 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureAPI.html +++ b/classes/_openfeature_web_sdk.OpenFeatureAPI.html @@ -1,4 +1,4 @@ -OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_apiEmitter _clientEvents _context @@ -36,91 +36,91 @@ setLogger setProvider setProviderAndWait -

Constructors

Private constructor

Properties

Protected _apiEmitter

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

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

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _apiEmitter

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

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

Protected _domainScopedContext

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

Protected _domainScopedProviders

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

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected _statusEnumType

_statusEnumType: typeof ProviderStatus = ProviderStatus

Accessors

Private allProviders

providerMetadata

Methods

Protected _createEventEmitter

addHandler

Methods

Protected _createEventEmitter

addHandler

addHooks

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

Protected buildAndCacheEventEmitterForClient

clearContext

  • clearContext(): Promise<void>

  • Resets the global evaluation context to an empty object.

    -

    Returns Promise<void>

  • clearContext(domain): Promise<void>

  • Removes the evaluation context for a specific named client.

    -

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

      -

    Returns Promise<void>

clearContexts

Protected buildAndCacheEventEmitterForClient

clearContext

  • clearContext(): Promise<void>

  • Resets the global evaluation context to an empty object.

    +

    Returns Promise<void>

  • clearContext(domain): Promise<void>

  • Removes the evaluation context for a specific named client.

    +

    Parameters

    • domain: string

      An identifier which logically binds clients with providers

      +

    Returns Promise<void>

clearContexts

clearHandlers

clearHooks

clearHandlers

clearHooks

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

clearProviders

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getClient

  • getClient(domain?, version?): Client

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

    If there is already a provider bound to this name via this.setProvider setProvider, this provider will be used. Otherwise, the default provider is used until a provider is assigned to that name.

    -

    Parameters

    • Optional domain: string

      An identifier which logically binds clients with providers

      -
    • Optional version: string

      The version of the client (only used for metadata)

      +

      Parameters

      • Optional domain: string

        An identifier which logically binds clients with providers

        +
      • Optional version: string

        The version of the client (only used for metadata)

      Returns Client

      OpenFeature Client

      -

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

Private getProviderStatus

removeHandler

Private runProviderContextChangeHandler

setContext

Private getProviderStatus

removeHandler

Private runProviderContextChangeHandler

setContext

  • setContext(context): Promise<void>

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

    -

    Parameters

    • context: EvaluationContext

      Evaluation context

      +

      Parameters

      Returns Promise<void>

      Example

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

    • Sets the evaluation context for a specific provider. +

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

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

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • context: EvaluationContext

        Evaluation context

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • context: EvaluationContext

          Evaluation context

        Returns Promise<void>

        Example

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

setLogger

  • setLogger(logger): this

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

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    -

    Parameters

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

setProviderAndWait

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: Provider

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: Provider

        The provider responsible for flag evaluations.

      Returns Promise<void>

      Throws

      Uncaught exceptions thrown by the provider during initialization.

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

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

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

    • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: Provider

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: Provider

          The provider responsible for flag evaluations.

        Returns Promise<void>

        Throws

        Uncaught exceptions thrown by the provider during initialization.

        -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureClient

Implements

Constructors

constructor +OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Private Readonly providerStatusAccessor

providerStatusAccessor: (() => ProviderStatus)

Type declaration

Accessors

Private _logger

Private _provider

metadata

providerStatus

Methods

addHandler

  • addHandler(eventType, handler): void

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

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Private Readonly providerStatusAccessor

providerStatusAccessor: (() => ProviderStatus)

Type declaration

Accessors

Private _logger

Private _provider

metadata

providerStatus

Methods

addHandler

addHooks

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

Private afterHooks

Private beforeHooks

clearHooks

Private afterHooks

Private beforeHooks

clearHooks

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

getBooleanValue

getBooleanValue

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

removeHandler

setLogger

removeHandler

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    -

    Parameters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<S, P, H>Abstract

Type Parameters

Hierarchy (view full)

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

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

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Protected Abstract Readonly _apiEmitter

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

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: ProviderWrapper<P, AnyProviderStatus>

Protected _domainScopedContext

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

Protected Abstract Readonly _domainScopedProviders

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

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Protected Abstract Readonly _statusEnumType

_statusEnumType: typeof ProviderStatus | typeof ServerProviderStatus

Accessors

Private allProviders

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

addHooks

addHooks

  • addHooks(...hooks): this

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHandlers

clearHooks

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Protected getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

  • getProviderMetadata(domain?): ProviderMetadata

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

    -

    Parameters

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

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

  • Parameters

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

    Returns void | Promise<void>

setLogger

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

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

  • Parameters

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

    Returns void | Promise<void>

setLogger

  • setLogger(logger): this

  • Sets a logger on this receiver. This logger supersedes to the global logger 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

setProvider

setProvider

  • setProvider(provider): this

  • Sets the default provider for flag evaluations. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: P

        The provider responsible for flag evaluations.

      Returns this

      OpenFeature API

      -
    • setProvider(domain, provider): this

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

    • setProvider(domain, provider): this

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

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: P

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: P

          The provider responsible for flag evaluations.

        Returns this

        OpenFeature API

        -

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

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

setProviderAndWait

  • setProviderAndWait(provider): Promise<void>

  • Sets the default provider for flag evaluations and returns a promise that resolves when the provider is ready. The default provider will be used by domainless clients and clients associated with domains to which no provider is bound. Setting a provider supersedes the current provider used in new and existing unbound clients.

    -

    Parameters

    • provider: P

      The provider responsible for flag evaluations.

      +

      Parameters

      • provider: P

        The provider responsible for flag evaluations.

      Returns Promise<void>

      Throws

      Uncaught exceptions thrown by the provider during initialization.

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

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

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

    • Sets the provider that OpenFeature will use for flag evaluations on clients bound to the same domain. A promise is returned that resolves when the provider is ready. Setting a provider supersedes the current provider used in new and existing clients in the same domain.

      -

      Parameters

      • domain: string

        An identifier which logically binds clients with providers

        -
      • provider: P

        The provider responsible for flag evaluations.

        +

        Parameters

        • domain: string

          An identifier which logically binds clients with providers

          +
        • provider: P

          The provider responsible for flag evaluations.

        Returns Promise<void>

        Throws

        Uncaught exceptions thrown by the provider during initialization.

        -

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html b/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html index 6f9f2bd5c..444b6e32d 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html +++ b/classes/_openfeature_web_sdk.OpenFeatureEventEmitter.html @@ -2,7 +2,7 @@ events at various parts of the provider lifecycle.

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

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

eventEmitter

Accessors

_logger

Methods

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

Constructors

constructor

Properties

Protected Readonly eventEmitter

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

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

  • setLogger(logger): this

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

Constructors

constructor

Properties

Protected Readonly eventEmitter

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

Accessors

Protected _logger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ParseError.html b/classes/_openfeature_web_sdk.ParseError.html index 4890a5d4e..69d1f9e6b 100644 --- a/classes/_openfeature_web_sdk.ParseError.html +++ b/classes/_openfeature_web_sdk.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ProviderFatalError.html b/classes/_openfeature_web_sdk.ProviderFatalError.html index 484caf35c..96f17af96 100644 --- a/classes/_openfeature_web_sdk.ProviderFatalError.html +++ b/classes/_openfeature_web_sdk.ProviderFatalError.html @@ -1,4 +1,4 @@ -ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor +ProviderFatalError | Documentation

Class ProviderFatalError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.ProviderNotReadyError.html b/classes/_openfeature_web_sdk.ProviderNotReadyError.html index 5ce863a5a..2b2850e55 100644 --- a/classes/_openfeature_web_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_web_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class ProviderWrapper<P, S>

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

-

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>

  • S extends AnyProviderStatus

Constructors

constructor +

Type Parameters

  • P extends CommonProvider<AnyProviderStatus>
  • S extends AnyProviderStatus

Constructors

constructor

Properties

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

Methods

decrementPendingContextChanges incrementPendingContextChanges -

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private _pendingContextChanges

_pendingContextChanges: number = 0

Private _provider

_provider: P

Private _status

_status: S

Accessors

allContextChangesSettled

provider

status

Methods

decrementPendingContextChanges

incrementPendingContextChanges

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.SafeLogger.html b/classes/_openfeature_web_sdk.SafeLogger.html index 5cb2c630a..958ab7513 100644 --- a/classes/_openfeature_web_sdk.SafeLogger.html +++ b/classes/_openfeature_web_sdk.SafeLogger.html @@ -1,4 +1,4 @@ -SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor +SafeLogger | Documentation

Class SafeLogger

Implements

Constructors

constructor

Properties

fallbackLogger logger

Methods

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

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

Private Readonly fallbackLogger

fallbackLogger: DefaultLogger = ...

Private Readonly logger

logger: Logger

Methods

debug

error

info

Private log

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html index 7348b23c7..2de5397ae 100644 --- a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html +++ b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.TypeMismatchError.html b/classes/_openfeature_web_sdk.TypeMismatchError.html index 86746c278..a66a4d252 100644 --- a/classes/_openfeature_web_sdk.TypeMismatchError.html +++ b/classes/_openfeature_web_sdk.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy (view full)

Constructors

constructor

Properties

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

Methods

captureStackTrace -

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

+

Constructors

constructor

Properties

Optional cause

cause?: unknown

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

See

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

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ClientProviderEvents.html b/enums/_openfeature_core.ClientProviderEvents.html index f9d0f7bab..9d40fa3ef 100644 --- a/enums/_openfeature_core.ClientProviderEvents.html +++ b/enums/_openfeature_core.ClientProviderEvents.html @@ -1,14 +1,14 @@ ClientProviderEvents | Documentation

Enumeration ClientProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Reconciling Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

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

-

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

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

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Reconciling

Reconciling: "PROVIDER_RECONCILING"

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

-

Stale

Stale: "PROVIDER_STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

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

+

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Reconciling

Reconciling: "PROVIDER_RECONCILING"

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

+

Stale

Stale: "PROVIDER_STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ClientProviderStatus.html b/enums/_openfeature_core.ClientProviderStatus.html index df792fcbe..8aad400e2 100644 --- a/enums/_openfeature_core.ClientProviderStatus.html +++ b/enums/_openfeature_core.ClientProviderStatus.html @@ -1,15 +1,15 @@ ClientProviderStatus | Documentation

Enumeration ClientProviderStatus

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

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY RECONCILING STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ErrorCode.html b/enums/_openfeature_core.ErrorCode.html index 787f0d6b0..8cb8df469 100644 --- a/enums/_openfeature_core.ErrorCode.html +++ b/enums/_openfeature_core.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND GENERAL INVALID_CONTEXT PARSE_ERROR @@ -7,11 +7,11 @@ TARGETING_KEY_MISSING TYPE_MISMATCH

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

-

PROVIDER_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

+

PROVIDER_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ServerProviderEvents

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

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

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ServerProviderStatus.html b/enums/_openfeature_core.ServerProviderStatus.html index ee8a420ab..be1885d8a 100644 --- a/enums/_openfeature_core.ServerProviderStatus.html +++ b/enums/_openfeature_core.ServerProviderStatus.html @@ -1,13 +1,13 @@ ServerProviderStatus | Documentation

Enumeration ServerProviderStatus

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

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ClientProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Reconciling Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

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

-

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

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

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Reconciling

Reconciling: "PROVIDER_RECONCILING"

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

-

Stale

Stale: "PROVIDER_STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

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

+

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Reconciling

Reconciling: "PROVIDER_RECONCILING"

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

+

Stale

Stale: "PROVIDER_STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ClientProviderStatus.html b/enums/_openfeature_server_sdk.ClientProviderStatus.html index 1300ac8e1..eea295819 100644 --- a/enums/_openfeature_server_sdk.ClientProviderStatus.html +++ b/enums/_openfeature_server_sdk.ClientProviderStatus.html @@ -1,15 +1,15 @@ ClientProviderStatus | Documentation

Enumeration ClientProviderStatus

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

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY RECONCILING STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND GENERAL INVALID_CONTEXT PARSE_ERROR @@ -7,11 +7,11 @@ TARGETING_KEY_MISSING TYPE_MISMATCH

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

-

PROVIDER_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

+

PROVIDER_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ProviderEvents.html b/enums/_openfeature_server_sdk.ProviderEvents.html index 4d1142f13..1e8975e52 100644 --- a/enums/_openfeature_server_sdk.ProviderEvents.html +++ b/enums/_openfeature_server_sdk.ProviderEvents.html @@ -1,10 +1,10 @@ ProviderEvents | Documentation

Enumeration ProviderEvents

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

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

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ProviderStatus

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

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ErrorCode.html b/enums/_openfeature_web_sdk.ErrorCode.html index 96f805514..1c533cda0 100644 --- a/enums/_openfeature_web_sdk.ErrorCode.html +++ b/enums/_openfeature_web_sdk.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND GENERAL INVALID_CONTEXT PARSE_ERROR @@ -7,11 +7,11 @@ TARGETING_KEY_MISSING TYPE_MISMATCH

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

-

PROVIDER_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

+

PROVIDER_FATAL

PROVIDER_FATAL: "PROVIDER_FATAL"

The provider has entered an irrecoverable error state.

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ProviderEvents.html b/enums/_openfeature_web_sdk.ProviderEvents.html index 08f0fcfde..f2137c7cf 100644 --- a/enums/_openfeature_web_sdk.ProviderEvents.html +++ b/enums/_openfeature_web_sdk.ProviderEvents.html @@ -1,14 +1,14 @@ ProviderEvents | Documentation

Enumeration ProviderEvents

An enumeration of possible events for web-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged ContextChanged Error Ready Reconciling Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

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

-

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

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

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Reconciling

Reconciling: "PROVIDER_RECONCILING"

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

-

Stale

Stale: "PROVIDER_STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

ContextChanged

ContextChanged: "PROVIDER_CONTEXT_CHANGED"

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

+

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Reconciling

Reconciling: "PROVIDER_RECONCILING"

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

+

Stale

Stale: "PROVIDER_STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ProviderStatus

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

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY RECONCILING STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

RECONCILING

RECONCILING: "RECONCILING"

The provider is reconciling its state with a context change.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ServerProviderEvents

An enumeration of possible events for server-sdk providers.

-

Enumeration Members

ConfigurationChanged +

Enumeration Members

ConfigurationChanged Error Ready Stale

Enumeration Members

ConfigurationChanged

ConfigurationChanged: "PROVIDER_CONFIGURATION_CHANGED"

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

-

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

-

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

-

Stale

Stale: "PROVIDER_STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Error

Error: "PROVIDER_ERROR"

The provider is in an error state.

+

Ready

Ready: "PROVIDER_READY"

The provider is ready to evaluate flags.

+

Stale

Stale: "PROVIDER_STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ServerProviderStatus.html b/enums/_openfeature_web_sdk.ServerProviderStatus.html index f69ccc2c9..6cac911e9 100644 --- a/enums/_openfeature_web_sdk.ServerProviderStatus.html +++ b/enums/_openfeature_web_sdk.ServerProviderStatus.html @@ -1,13 +1,13 @@ ServerProviderStatus | Documentation

Enumeration ServerProviderStatus

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

-

Enumeration Members

ERROR +

Enumeration Members

ERROR FATAL NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

FATAL

FATAL: "FATAL"

The provider has entered an irrecoverable error state.

+

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Function isObject

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

  • Checks whether the parameter is an object.

    -

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

      +

      Type Parameters

      • T extends object

      Parameters

      • value: unknown

        The value to check

      Returns value is T

      True if the value is an object

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    -

    Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.objectOrUndefined.html b/functions/_openfeature_core.objectOrUndefined.html index a1d317df0..2da70a184 100644 --- a/functions/_openfeature_core.objectOrUndefined.html +++ b/functions/_openfeature_core.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation

Function objectOrUndefined

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

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

    -

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

      +

      Type Parameters

      • T extends object

      Parameters

      • value: unknown

        The value to check

      Returns T | undefined

      The parameter if it is an object, otherwise undefined

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.statusMatchesEvent.html b/functions/_openfeature_core.statusMatchesEvent.html index 26d58e290..6a4ec4681 100644 --- a/functions/_openfeature_core.statusMatchesEvent.html +++ b/functions/_openfeature_core.statusMatchesEvent.html @@ -1,6 +1,6 @@ statusMatchesEvent | Documentation

Function statusMatchesEvent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

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

    -

    Parameters

    • value: unknown

      The value to check

      +

      Parameters

      • value: unknown

        The value to check

      Returns string | undefined

      The parameter if it is a string, otherwise undefined

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isObject

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

  • Checks whether the parameter is an object.

    -

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

      +

      Type Parameters

      • T extends object

      Parameters

      • value: unknown

        The value to check

      Returns value is T

      True if the value is an object

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    -

    Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.objectOrUndefined.html b/functions/_openfeature_server_sdk.objectOrUndefined.html index 9c32cf1bd..74d45e23b 100644 --- a/functions/_openfeature_server_sdk.objectOrUndefined.html +++ b/functions/_openfeature_server_sdk.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation

Function objectOrUndefined

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

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

    -

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

      +

      Type Parameters

      • T extends object

      Parameters

      • value: unknown

        The value to check

      Returns T | undefined

      The parameter if it is an object, otherwise undefined

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_server_sdk.statusMatchesEvent.html b/functions/_openfeature_server_sdk.statusMatchesEvent.html index 35e960f18..f31db11d9 100644 --- a/functions/_openfeature_server_sdk.statusMatchesEvent.html +++ b/functions/_openfeature_server_sdk.statusMatchesEvent.html @@ -1,6 +1,6 @@ statusMatchesEvent | Documentation

Function statusMatchesEvent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

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

    -

    Parameters

    • value: unknown

      The value to check

      +

      Parameters

      • value: unknown

        The value to check

      Returns string | undefined

      The parameter if it is a string, otherwise undefined

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.isObject.html b/functions/_openfeature_web_sdk.isObject.html index 552248e3c..41d2c9a24 100644 --- a/functions/_openfeature_web_sdk.isObject.html +++ b/functions/_openfeature_web_sdk.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation

Function isObject

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

  • Checks whether the parameter is an object.

    -

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

      +

      Type Parameters

      • T extends object

      Parameters

      • value: unknown

        The value to check

      Returns value is T

      True if the value is an object

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.isString.html b/functions/_openfeature_web_sdk.isString.html index 88076460d..a73ef9e67 100644 --- a/functions/_openfeature_web_sdk.isString.html +++ b/functions/_openfeature_web_sdk.isString.html @@ -1,4 +1,4 @@ isString | Documentation

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    -

    Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.objectOrUndefined.html b/functions/_openfeature_web_sdk.objectOrUndefined.html index 59f10edd6..e8bf2ad29 100644 --- a/functions/_openfeature_web_sdk.objectOrUndefined.html +++ b/functions/_openfeature_web_sdk.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation

Function objectOrUndefined

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

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

    -

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

      +

      Type Parameters

      • T extends object

      Parameters

      • value: unknown

        The value to check

      Returns T | undefined

      The parameter if it is an object, otherwise undefined

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.statusMatchesEvent.html b/functions/_openfeature_web_sdk.statusMatchesEvent.html index 798028ada..e0d86ae07 100644 --- a/functions/_openfeature_web_sdk.statusMatchesEvent.html +++ b/functions/_openfeature_web_sdk.statusMatchesEvent.html @@ -1,6 +1,6 @@ statusMatchesEvent | Documentation

Function statusMatchesEvent

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_web_sdk.stringOrUndefined.html b/functions/_openfeature_web_sdk.stringOrUndefined.html index 7015c085d..75c4a3398 100644 --- a/functions/_openfeature_web_sdk.stringOrUndefined.html +++ b/functions/_openfeature_web_sdk.stringOrUndefined.html @@ -1,4 +1,4 @@ stringOrUndefined | Documentation

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

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

    -

    Parameters

    • value: unknown

      The value to check

      +

      Parameters

      • value: unknown

        The value to check

      Returns string | undefined

      The parameter if it is a string, otherwise undefined

      -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

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

Type Parameters

Methods

after? +BaseHook | Documentation

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

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

Type Parameters

Methods

after? before? error? finally?

Methods

Optional after

Optional before

Optional before

Optional error

Optional finally

Optional error

Optional finally

  • finally(hookContext, hookHints?): HooksReturn

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

    -

    Parameters

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

    Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface BeforeHookContext

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

Hierarchy (view full)

Properties

clientMetadata +BeforeHookContext | Documentation

Interface BeforeHookContext

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

Hierarchy (view full)

Properties

clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface ClientMetadata

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

Hierarchy (view full)

Properties

domain? +ClientMetadata | Documentation

Interface ClientMetadata

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

Hierarchy (view full)

Properties

domain? name? providerMetadata version? -

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

-

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

+

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface CommonProvider<S>

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

Type Parameters

Properties

events? +CommonProvider | Documentation

Interface CommonProvider<S>

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

Type Parameters

Properties

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

Properties

Optional events

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

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

-

Optional Readonly status

status?: S

Deprecated

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

Optional Readonly status

status?: S

Deprecated

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

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

-

Methods

Optional initialize

Methods

Optional initialize

  • initialize(context?): Promise<void>

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

    -

    Parameters

    Returns Promise<void>

Optional onClose

Optional onClose

  • onClose(): Promise<void>

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

    -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface EvaluationLifeCycle<T>

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

Type Parameters

  • T

Implemented by

Methods

addHooks +EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

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

Type Parameters

  • T

Implemented by

Methods

addHooks clearHooks getHooks

Methods

addHooks

  • addHooks(...hooks): T

  • Adds hooks that will run during flag evaluations on this receiver. @@ -6,10 +6,10 @@ 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

clearHooks

clearHooks

getHooks

getHooks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface Eventing<T>

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

Type Parameters

Implemented by

Methods

addHandler +Eventing | Documentation

Interface Eventing<T>

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

Type Parameters

Implemented by

Methods

addHandler getHandlers removeHandler

Methods

addHandler

getHandlers

getHandlers

removeHandler

  • removeHandler(eventType, handler): void

  • Removes a handler for the given provider event type.

    -

    Parameters

    • eventType: T

      The provider event type to remove the listener for

      -
    • handler: EventHandler<T>

      The handler to remove for the provider event type

      -

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

removeHandler

  • removeHandler(eventType, handler): void

  • Removes a handler for the given provider event type.

    +

    Parameters

    • eventType: T

      The provider event type to remove the listener for

      +
    • handler: EventHandler<T>

      The handler to remove for the provider event type

      +

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface HookContext<T>

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

Type Parameters

Hierarchy (view full)

Properties

clientMetadata +HookContext | Documentation

Interface HookContext<T>

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

Type Parameters

Hierarchy (view full)

Properties

clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

Readonly context

context: Readonly<EvaluationContext>

Readonly defaultValue

defaultValue: T

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

Readonly context

context: Readonly<EvaluationContext>

Readonly defaultValue

defaultValue: T

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface Logger

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

Implemented by

Methods

debug +Logger | Documentation

Interface Logger

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

Implemented by

Methods

debug error info warn -

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Methods

debug

error

info

warn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ManageContext.html b/interfaces/_openfeature_core.ManageContext.html index 60694a4f3..0c5cd1890 100644 --- a/interfaces/_openfeature_core.ManageContext.html +++ b/interfaces/_openfeature_core.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation

Interface ManageContext<T>

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

Type Parameters

  • T

Methods

getContext +ManageContext | Documentation

Interface ManageContext<T>

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

Type Parameters

  • T

Methods

getContext setContext

Methods

getContext

setContext

setContext

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ManageLogger.html b/interfaces/_openfeature_core.ManageLogger.html index 5280cc7b4..e85235481 100644 --- a/interfaces/_openfeature_core.ManageLogger.html +++ b/interfaces/_openfeature_core.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation

Interface ManageLogger<T>

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

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

setLogger +ManageLogger | Documentation

Interface ManageLogger<T>

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

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

setLogger

Methods

setLogger

  • setLogger(logger): T

  • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

    -

    Parameters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.Metadata.html b/interfaces/_openfeature_core.Metadata.html index a4a0345e5..921737fa1 100644 --- a/interfaces/_openfeature_core.Metadata.html +++ b/interfaces/_openfeature_core.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

Interface Metadata

interface Metadata {}

Hierarchy (view full)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Metadata | Documentation

Interface Metadata

interface Metadata {}

Hierarchy (view full)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.ProviderEventEmitter.html b/interfaces/_openfeature_core.ProviderEventEmitter.html index 474c5c970..9d504cc18 100644 --- a/interfaces/_openfeature_core.ProviderEventEmitter.html +++ b/interfaces/_openfeature_core.ProviderEventEmitter.html @@ -1,16 +1,16 @@ ProviderEventEmitter | Documentation

Interface ProviderEventEmitter<E, AdditionalContext>

Event emitter to be optionally implemented by providers. Implemented by

See

OpenFeatureEventEmitter.

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

Type Parameters

  • E extends AnyProviderEvent

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

Hierarchy (view full)

Implemented by

Methods

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

Type Parameters

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

Hierarchy (view full)

Implemented by

Methods

addHandler emit getHandlers removeAllHandlers removeHandler setLogger -

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

Methods

addHandler

emit

getHandlers

removeAllHandlers

removeHandler

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface ProviderMetadata

Static data about the provider.

-
interface ProviderMetadata {
    name: string;
}

Hierarchy (view full)

Properties

name -

Properties

Readonly name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Hierarchy (view full)

Properties

name +

Properties

Readonly name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

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

Type Parameters

Methods

after? +BaseHook | Documentation

Interface BaseHook<T, BeforeHookReturn, HooksReturn>

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

Type Parameters

Methods

after? before? error? finally?

Methods

Optional after

Optional before

Optional before

Optional error

Optional finally

Optional error

Optional finally

  • finally(hookContext, hookHints?): HooksReturn

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

    -

    Parameters

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

    Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Parameters

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

Returns HooksReturn

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface BeforeHookContext

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

Hierarchy (view full)

Properties

clientMetadata +BeforeHookContext | Documentation

Interface BeforeHookContext

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

Hierarchy (view full)

Properties

clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Readonly clientMetadata

clientMetadata: ClientMetadata

context

context: EvaluationContext

Readonly defaultValue

defaultValue: FlagValue

Readonly flagKey

flagKey: string

Readonly flagValueType

flagValueType: FlagValueType

Readonly logger

logger: Logger

Readonly providerMetadata

providerMetadata: ProviderMetadata

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface Client

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

Hierarchy (view full)

Implemented by

Properties

metadata +Client | Documentation

Interface Client

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

Hierarchy (view full)

Implemented by

Properties

metadata providerStatus

Methods

addHandler addHooks @@ -17,86 +17,86 @@ removeHandler setContext setLogger -

Properties

Readonly metadata

metadata: ClientMetadata

Readonly providerStatus

providerStatus: ProviderStatus

Returns the status of the associated provider.

-

Methods

addHandler

  • addHandler(eventType, handler): void

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

Properties

Readonly metadata

metadata: ClientMetadata

Readonly providerStatus

providerStatus: ProviderStatus

Returns the status of the associated provider.

+

Methods

addHandler

addHooks

addHooks

  • addHooks(...hooks): Client

  • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    -

    Parameters

clearHooks

clearHooks

getBooleanDetails

getBooleanDetails

getBooleanValue

getBooleanValue

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

  • Performs a flag evaluation that returns a boolean.

    +

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

      +
    • defaultValue: boolean

      The value returned if an error occurs

      +
    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

      +
    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<boolean>

    Flag evaluation response

    -

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

removeHandler

setContext

removeHandler

setContext

setLogger

setLogger

  • setLogger(logger): Client

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface ClientMetadata

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

Hierarchy (view full)

Properties

domain? +ClientMetadata | Documentation

Interface ClientMetadata

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

Hierarchy (view full)

Properties

domain? name? providerMetadata version? -

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

-

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Properties

Optional Readonly domain

domain?: string

Optional Readonly name

name?: string

Deprecated

alias of "domain", use domain instead

+

Readonly providerMetadata

providerMetadata: ProviderMetadata

Optional Readonly version

version?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface CommonProvider<S>

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

Type Parameters

Hierarchy (view full)

Properties

events? +CommonProvider | Documentation

Interface CommonProvider<S>

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

Type Parameters

Hierarchy (view full)

Properties

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

Properties

Optional events

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

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

-

Optional Readonly status

status?: S

Deprecated

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

Optional Readonly status

status?: S

Deprecated

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

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

-

Methods

Optional initialize

Methods

Optional initialize

  • initialize(context?): Promise<void>

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

    -

    Parameters

    Returns Promise<void>

Optional onClose

Optional onClose

  • onClose(): Promise<void>

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

    -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface EvaluationLifeCycle<T>

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

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

addHooks +EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

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

Type Parameters

  • T

Hierarchy (view full)

Implemented by

Methods

addHooks clearHooks getHooks

Methods

addHooks

  • addHooks(...hooks): T

  • Adds hooks that will run during flag evaluations on this receiver. @@ -6,10 +6,10 @@ 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

clearHooks

clearHooks

getHooks

getHooks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface Eventing<T>

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

Type Parameters

Hierarchy (view full)

Implemented by

Methods

addHandler +Eventing | Documentation

Interface Eventing<T>

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

Type Parameters

Hierarchy (view full)

Implemented by

Methods

addHandler getHandlers removeHandler

Methods

addHandler

getHandlers

getHandlers

removeHandler

  • removeHandler(eventType, handler): void

  • Removes a handler for the given provider event type.

    -

    Parameters

    • eventType: T

      The provider event type to remove the listener for

      -
    • handler: EventHandler<T>

      The handler to remove for the provider event type

      -

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

removeHandler

  • removeHandler(eventType, handler): void

  • Removes a handler for the given provider event type.

    +

    Parameters

    • eventType: T

      The provider event type to remove the listener for

      +
    • handler: EventHandler<T>

      The handler to remove for the provider event type

      +

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Features.html b/interfaces/_openfeature_server_sdk.Features.html index 91da85f75..a802c3f27 100644 --- a/interfaces/_openfeature_server_sdk.Features.html +++ b/interfaces/_openfeature_server_sdk.Features.html @@ -1,4 +1,4 @@ -Features | Documentation

Interface Features

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

Hierarchy (view full)

Methods

getBooleanDetails +Features | Documentation

Interface Features

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

Hierarchy (view full)

Methods

getBooleanDetails getBooleanValue getNumberDetails getNumberValue @@ -7,51 +7,51 @@ getStringDetails getStringValue

Methods

getBooleanDetails

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

  • Performs a flag evaluation that a returns an evaluation details object.

    -

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

      -
    • defaultValue: boolean

      The value returned if an error occurs

      -
    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

      -
    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

      +

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

        +
      • defaultValue: boolean

        The value returned if an error occurs

        +
      • Optional context: EvaluationContext

        The evaluation context used on an individual flag evaluation

        +
      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns Promise<EvaluationDetails<boolean>>

      Flag evaluation details response

      -

getBooleanValue

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

  • Performs a flag evaluation that returns a boolean.

    -

    Parameters

getBooleanValue

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

  • Performs a flag evaluation that returns a boolean.

    +

    Parameters

    • flagKey: string

      The flag key uniquely identifies a particular flag

      +
    • defaultValue: boolean

      The value returned if an error occurs

      +
    • Optional context: EvaluationContext

      The evaluation context used on an individual flag evaluation

      +
    • Optional options: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<boolean>

    Flag evaluation response

    -

getNumberDetails

  • getNumberDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<number>>

  • Performs a flag evaluation that a returns an evaluation details object.

    -

    Parameters

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

  • Type Parameters

    • T extends string = string

    Parameters

    Returns Promise<T>

    • Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html index 2035aed6f..73eeddd5c 100644 --- a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html +++ b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html @@ -1,3 +1,3 @@ -FlagEvaluationOptions | Documentation

    Interface FlagEvaluationOptions

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

    Properties

    hookHints? +FlagEvaluationOptions | Documentation

    Interface FlagEvaluationOptions

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

    Properties

    hookHints? hooks? -

    Properties

    Optional hookHints

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

    Optional hooks

    hooks?: Hook[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional hookHints

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

    Optional hooks

    hooks?: Hook[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface HookContext<T>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata +HookContext | Documentation

    Interface HookContext<T>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Logger.html b/interfaces/_openfeature_server_sdk.Logger.html index 6ec3a7873..9418bfd75 100644 --- a/interfaces/_openfeature_server_sdk.Logger.html +++ b/interfaces/_openfeature_server_sdk.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation

    Interface Logger

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

    Implemented by

    Methods

    debug +Logger | Documentation

    Interface Logger

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

    Implemented by

    Methods

    debug error info warn -

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ManageContext<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getContext +ManageContext | Documentation

    Interface ManageContext<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getContext setContext

    Methods

    getContext

    setContext

    setContext

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageLogger.html b/interfaces/_openfeature_server_sdk.ManageLogger.html index 83cda074c..151a1323f 100644 --- a/interfaces/_openfeature_server_sdk.ManageLogger.html +++ b/interfaces/_openfeature_server_sdk.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation

    Interface ManageLogger<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation

    Interface ManageLogger<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger

    Methods

    setLogger

    • setLogger(logger): T

    • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

      -

      Parameters

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html b/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html index 6c297963a..891319456 100644 --- a/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html +++ b/interfaces/_openfeature_server_sdk.ManageTransactionContextPropagator.html @@ -1,10 +1,10 @@ -ManageTransactionContextPropagator | Documentation

    Interface ManageTransactionContextPropagator<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext +ManageTransactionContextPropagator | Documentation

    Interface ManageTransactionContextPropagator<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext setTransactionContext setTransactionContextPropagator

    Methods

    getTransactionContext

    setTransactionContext

    setTransactionContext

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

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

      The TransactionContextPropagator must persist the transactionContext and make it available @@ -13,14 +13,14 @@

      Example:

      app.use((req: Request, res: Response, next: NextFunction) => {
          const ip = res.headers.get("X-Forwarded-For")
          OpenFeature.setTransactionContext({ targetingKey: req.user.id, ipAddress: ip }, () => {
              // The transaction context is used in any flag evaluation throughout the whole call chain of next
              next();
          });
      })
      -

      Type Parameters

      • TArgs extends unknown[]

        The optional args passed to the callback function

        -

      • R

        The return value of the callback

        -

      Parameters

      • transactionContext: EvaluationContext

        The transaction specific context

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

        Callback function to run

        -
          • (...args): R

          • Parameters

            Returns R

      • Rest ...args: TArgs

        Optional arguments that are passed to the callback function

        -

      Returns void

    setTransactionContextPropagator

    setTransactionContextPropagator

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Metadata.html b/interfaces/_openfeature_server_sdk.Metadata.html index 549c70d3b..758956c94 100644 --- a/interfaces/_openfeature_server_sdk.Metadata.html +++ b/interfaces/_openfeature_server_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Interface Provider

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

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

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

    Hierarchy (view full)

    Implemented by

    Properties

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

    Hierarchy (view full)

    Implemented by

    Properties

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

    Properties

    Optional events

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

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Optional Readonly hooks

    hooks?: Hook[]

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

    Optional Readonly hooks

    hooks?: Hook[]

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

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    -

    Optional Readonly status

    status?: ProviderStatus

    Deprecated

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

    Optional Readonly status

    status?: ProviderStatus

    Deprecated

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

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

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

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

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProviderEventEmitter<E, AdditionalContext>

    Event emitter to be optionally implemented by providers. Implemented by

    See

    OpenFeatureEventEmitter.

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

    Type Parameters

    • E extends AnyProviderEvent

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

    Hierarchy (view full)

    Implemented by

    Methods

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

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler emit getHandlers removeAllHandlers removeHandler setLogger -

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ProviderMetadata.html b/interfaces/_openfeature_server_sdk.ProviderMetadata.html index a67a064d1..823d78b36 100644 --- a/interfaces/_openfeature_server_sdk.ProviderMetadata.html +++ b/interfaces/_openfeature_server_sdk.ProviderMetadata.html @@ -1,3 +1,3 @@ ProviderMetadata | Documentation

    Interface ProviderMetadata

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Hierarchy (view full)

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface TransactionContextPropagator

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

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext +TransactionContextPropagator | Documentation

    Interface TransactionContextPropagator

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

    Hierarchy (view full)

    Implemented by

    Methods

    getTransactionContext setTransactionContext

    Methods

    getTransactionContext

    setTransactionContext

    setTransactionContext

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

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

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

      Example:

      app.use((req: Request, res: Response, next: NextFunction) => {
          const ip = res.headers.get("X-Forwarded-For")
          OpenFeature.setTransactionContext({ targetingKey: req.user.id, ipAddress: ip }, () => {
              // The transaction context is used in any flag evaluation throughout the whole call chain of next
              next();
          });
      })
      -

      Type Parameters

      • TArgs extends unknown[]

        The optional args passed to the callback function

        -

      • R

        The return value of the callback

        -

      Parameters

      • transactionContext: EvaluationContext

        The transaction specific context

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

        Callback function to run

        -
          • (...args): R

          • Parameters

            Returns R

      • Rest ...args: TArgs

        Optional arguments that are passed to the callback function

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Type Parameters

    • TArgs extends unknown[]

      The optional args passed to the callback function

      +
    • R

      The return value of the callback

      +

    Parameters

    • transactionContext: EvaluationContext

      The transaction specific context

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

      Callback function to run

      +
        • (...args): R

        • Parameters

          Returns R

    • Rest ...args: TArgs

      Optional arguments that are passed to the callback function

      +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface BaseHook<T, BeforeHookReturn, HooksReturn>

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

    Type Parameters

    Methods

    after? +BaseHook | Documentation

    Interface BaseHook<T, BeforeHookReturn, HooksReturn>

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

    Type Parameters

    Methods

    after? before? error? finally?

    Methods

    Optional after

    Optional before

    Optional before

    Optional error

    Optional finally

    Optional error

    Optional finally

    • finally(hookContext, hookHints?): HooksReturn

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

      -

      Parameters

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

      Returns HooksReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

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

    Returns HooksReturn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface BeforeHookContext

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

    Hierarchy (view full)

    Properties

    clientMetadata +BeforeHookContext | Documentation

    Interface BeforeHookContext

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

    Hierarchy (view full)

    Properties

    clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    context

    context: EvaluationContext

    Readonly defaultValue

    defaultValue: FlagValue

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    context

    context: EvaluationContext

    Readonly defaultValue

    defaultValue: FlagValue

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface Client

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

    Hierarchy (view full)

    Implemented by

    Properties

    metadata +Client | Documentation

    Interface Client

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

    Hierarchy (view full)

    Implemented by

    Properties

    metadata providerStatus

    Methods

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

    Properties

    Readonly metadata

    metadata: ClientMetadata

    Readonly providerStatus

    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    -

    Methods

    addHandler

    • addHandler(eventType, handler): void

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

    Properties

    Readonly metadata

    metadata: ClientMetadata

    Readonly providerStatus

    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    +

    Methods

    addHandler

    addHooks

    addHooks

    • addHooks(...hooks): Client

    • Adds hooks that will run during flag evaluations on this receiver. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

      -

      Parameters

    clearHooks

    clearHooks

    getBooleanDetails

    getBooleanDetails

    getBooleanValue

    getBooleanValue

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

    • Performs a flag evaluation that returns a boolean.

      +

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

        +
      • defaultValue: boolean

        The value returned if an error occurs

        +
      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns boolean

      Flag evaluation response

      -

    getHandlers

    getHandlers

    getHooks

    getHooks

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    removeHandler

    setLogger

    removeHandler

    setLogger

    • setLogger(logger): Client

    • 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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ClientMetadata

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

    Hierarchy (view full)

    Properties

    domain? +ClientMetadata | Documentation

    Interface ClientMetadata

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

    Hierarchy (view full)

    Properties

    domain? name? providerMetadata version? -

    Properties

    Optional Readonly domain

    domain?: string

    Optional Readonly name

    name?: string

    Deprecated

    alias of "domain", use domain instead

    -

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Optional Readonly version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly domain

    domain?: string

    Optional Readonly name

    name?: string

    Deprecated

    alias of "domain", use domain instead

    +

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Optional Readonly version

    version?: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface CommonProvider<S>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    events? +CommonProvider | Documentation

    Interface CommonProvider<S>

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

    Type Parameters

    Hierarchy (view full)

    Properties

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

    Properties

    Optional events

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

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    -

    Optional Readonly status

    status?: S

    Deprecated

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

    Optional Readonly status

    status?: S

    Deprecated

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

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

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

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

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    • onClose(): Promise<void>

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

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html index 49e1e5f73..563ee91e1 100644 --- a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html +++ b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html @@ -1,4 +1,4 @@ -EvaluationLifeCycle | Documentation

    Interface EvaluationLifeCycle<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    addHooks +EvaluationLifeCycle | Documentation

    Interface EvaluationLifeCycle<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    addHooks clearHooks getHooks

    Methods

    addHooks

    • addHooks(...hooks): T

    • Adds hooks that will run during flag evaluations on this receiver. @@ -6,10 +6,10 @@ 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

    clearHooks

    clearHooks

    getHooks

    getHooks

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface Eventing<T>

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

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler +Eventing | Documentation

    Interface Eventing<T>

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

    Type Parameters

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler getHandlers removeHandler

    Methods

    addHandler

    getHandlers

    getHandlers

    removeHandler

    • removeHandler(eventType, handler): void

    • Removes a handler for the given provider event type.

      -

      Parameters

      • eventType: T

        The provider event type to remove the listener for

        -
      • handler: EventHandler<T>

        The handler to remove for the provider event type

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    removeHandler

    • removeHandler(eventType, handler): void

    • Removes a handler for the given provider event type.

      +

      Parameters

      • eventType: T

        The provider event type to remove the listener for

        +
      • handler: EventHandler<T>

        The handler to remove for the provider event type

        +

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface Features

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

    Hierarchy (view full)

    Methods

    getBooleanDetails +Features | Documentation

    Interface Features

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

    Hierarchy (view full)

    Methods

    getBooleanDetails getBooleanValue getNumberDetails getNumberValue @@ -7,43 +7,43 @@ getStringDetails getStringValue

    Methods

    getBooleanDetails

    • getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>

    • Performs a flag evaluation that a returns an evaluation details object.

      -

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

        -
      • defaultValue: boolean

        The value returned if an error occurs

        -
      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

        +

        Parameters

        • flagKey: string

          The flag key uniquely identifies a particular flag

          +
        • defaultValue: boolean

          The value returned if an error occurs

          +
        • Optional options: FlagEvaluationOptions

          Additional flag evaluation options

        Returns EvaluationDetails<boolean>

        Flag evaluation details response

        -

    getBooleanValue

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

    • Performs a flag evaluation that returns a boolean.

      -

      Parameters

    getBooleanValue

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

    • Performs a flag evaluation that returns a boolean.

      +

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

        +
      • defaultValue: boolean

        The value returned if an error occurs

        +
      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns boolean

      Flag evaluation response

      -

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

  • Type Parameters

    • T extends string = string

    Parameters

    Returns T

    • Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface FlagEvaluationOptions

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

    Properties

    hookHints? +FlagEvaluationOptions | Documentation

    Interface FlagEvaluationOptions

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

    Properties

    hookHints? hooks? -

    Properties

    Optional hookHints

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

    Optional hooks

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional hookHints

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

    Optional hooks

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

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface HookContext<T>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata +HookContext | Documentation

    Interface HookContext<T>

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

    Type Parameters

    Hierarchy (view full)

    Properties

    clientMetadata context defaultValue flagKey flagValueType logger providerMetadata -

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly clientMetadata

    clientMetadata: ClientMetadata

    Readonly context

    context: Readonly<EvaluationContext>

    Readonly defaultValue

    defaultValue: T

    Readonly flagKey

    flagKey: string

    Readonly flagValueType

    flagValueType: FlagValueType

    Readonly logger

    logger: Logger

    Readonly providerMetadata

    providerMetadata: ProviderMetadata

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Logger.html b/interfaces/_openfeature_web_sdk.Logger.html index 8e48ce6af..91b7dca77 100644 --- a/interfaces/_openfeature_web_sdk.Logger.html +++ b/interfaces/_openfeature_web_sdk.Logger.html @@ -1,5 +1,5 @@ -Logger | Documentation

    Interface Logger

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

    Implemented by

    Methods

    debug +Logger | Documentation

    Interface Logger

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

    Implemented by

    Methods

    debug error info warn -

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Methods

    debug

    error

    info

    warn

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ManageContext<T>

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

    Type Parameters

    • T

    Implemented by

    Methods

    getContext +ManageContext | Documentation

    Interface ManageContext<T>

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

    Type Parameters

    • T

    Implemented by

    Methods

    getContext setContext

    Methods

    getContext

    setContext

    setContext

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ManageLogger<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation

    Interface ManageLogger<T>

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

    Type Parameters

    • T

    Hierarchy (view full)

    Implemented by

    Methods

    setLogger

    Methods

    setLogger

    • setLogger(logger): T

    • Sets a logger on this receiver. This logger supersedes to the global logger and is passed to various components in the SDK. The logger configured on the global API object will be used for all evaluations, unless overridden in a particular client.

      -

      Parameters

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy (view full)

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Provider.html b/interfaces/_openfeature_web_sdk.Provider.html index 6a70b1545..6f2087e41 100644 --- a/interfaces/_openfeature_web_sdk.Provider.html +++ b/interfaces/_openfeature_web_sdk.Provider.html @@ -1,7 +1,7 @@ Provider | Documentation

    Interface Provider

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

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

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

    Hierarchy (view full)

    Implemented by

    Properties

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

    Hierarchy (view full)

    Implemented by

    Properties

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

    Properties

    Optional events

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

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Optional Readonly hooks

    hooks?: Hook[]

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

    Optional Readonly hooks

    hooks?: Hook[]

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

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    -

    Optional Readonly status

    status?: ProviderStatus

    Deprecated

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

    Optional Readonly status

    status?: ProviderStatus

    Deprecated

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

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

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

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

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    Optional onContextChange

    Optional onContextChange

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProviderEventEmitter<E, AdditionalContext>

    Event emitter to be optionally implemented by providers. Implemented by

    See

    OpenFeatureEventEmitter.

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

    Type Parameters

    • E extends AnyProviderEvent

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

    Hierarchy (view full)

    Implemented by

    Methods

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

    Type Parameters

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

    Hierarchy (view full)

    Implemented by

    Methods

    addHandler emit getHandlers removeAllHandlers removeHandler setLogger -

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Methods

    addHandler

    emit

    getHandlers

    removeAllHandlers

    removeHandler

    setLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProviderMetadata

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy (view full)

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Hierarchy (view full)

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.AnyProviderEvent.html b/types/_openfeature_core.AnyProviderEvent.html index 07079625c..cc25b169c 100644 --- a/types/_openfeature_core.AnyProviderEvent.html +++ b/types/_openfeature_core.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    Type alias AnyProviderEvent

    AnyProviderEvent: ServerProviderEvents | ClientProviderEvents

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: string

      Deprecated

      alias of "domain", use domain instead

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ErrorEvent.html b/types/_openfeature_core.ErrorEvent.html index 0ab43c7d0..04ab9918b 100644 --- a/types/_openfeature_core.ErrorEvent.html +++ b/types/_openfeature_core.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EvaluationContextValue.html b/types/_openfeature_core.EvaluationContextValue.html index 665a03538..626fc1d53 100644 --- a/types/_openfeature_core.EvaluationContextValue.html +++ b/types/_openfeature_core.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EvaluationDetails<T>

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

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

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

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EventContext<U, T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U, T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EventDetails<T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails<T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.EventMetadata.html b/types/_openfeature_core.EventMetadata.html index 73d1aed95..2483c986c 100644 --- a/types/_openfeature_core.EventMetadata.html +++ b/types/_openfeature_core.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation

    Type alias EventMetadata

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventMetadata | Documentation

    Type alias EventMetadata

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias FlagMetadata

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

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias FlagValue

    FlagValue: boolean | string | number | JsonValue

    Represents a JSON node value, or Date.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.FlagValueType.html b/types/_openfeature_core.FlagValueType.html index 4e9c4b508..79813a3c7 100644 --- a/types/_openfeature_core.FlagValueType.html +++ b/types/_openfeature_core.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.JsonObject.html b/types/_openfeature_core.JsonObject.html index 130abaa18..c200dd496 100644 --- a/types/_openfeature_core.JsonObject.html +++ b/types/_openfeature_core.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Paradigm

    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ReadyEvent.html b/types/_openfeature_core.ReadyEvent.html index 81a175fc3..9c6fea729 100644 --- a/types/_openfeature_core.ReadyEvent.html +++ b/types/_openfeature_core.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ResolutionDetails.html b/types/_openfeature_core.ResolutionDetails.html index ad2b42c55..5c6479a2f 100644 --- a/types/_openfeature_core.ResolutionDetails.html +++ b/types/_openfeature_core.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

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

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

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

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.StaleEvent.html b/types/_openfeature_core.StaleEvent.html index 4536940b6..adec33621 100644 --- a/types/_openfeature_core.StaleEvent.html +++ b/types/_openfeature_core.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.AnyProviderEvent.html b/types/_openfeature_server_sdk.AnyProviderEvent.html index 9a2af0299..7dcb3a6f1 100644 --- a/types/_openfeature_server_sdk.AnyProviderEvent.html +++ b/types/_openfeature_server_sdk.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    Type alias AnyProviderEvent

    AnyProviderEvent: ProviderEvents | ClientProviderEvents

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: string

      Deprecated

      alias of "domain", use domain instead

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ErrorEvent.html b/types/_openfeature_server_sdk.ErrorEvent.html index 7c32f0d31..902b446b8 100644 --- a/types/_openfeature_server_sdk.ErrorEvent.html +++ b/types/_openfeature_server_sdk.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationContext.html b/types/_openfeature_server_sdk.EvaluationContext.html index 7e5785f44..3236207da 100644 --- a/types/_openfeature_server_sdk.EvaluationContext.html +++ b/types/_openfeature_server_sdk.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationContextValue.html b/types/_openfeature_server_sdk.EvaluationContextValue.html index 574448b1d..4b3bb78da 100644 --- a/types/_openfeature_server_sdk.EvaluationContextValue.html +++ b/types/_openfeature_server_sdk.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EvaluationDetails.html b/types/_openfeature_server_sdk.EvaluationDetails.html index 6d733ede4..319bda20c 100644 --- a/types/_openfeature_server_sdk.EvaluationDetails.html +++ b/types/_openfeature_server_sdk.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

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

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

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

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventContext.html b/types/_openfeature_server_sdk.EventContext.html index 2738cc19b..4043895da 100644 --- a/types/_openfeature_server_sdk.EventContext.html +++ b/types/_openfeature_server_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<U, T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U, T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EventDetails<T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails<T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventHandler.html b/types/_openfeature_server_sdk.EventHandler.html index 4298eeccb..9838330ff 100644 --- a/types/_openfeature_server_sdk.EventHandler.html +++ b/types/_openfeature_server_sdk.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EventMetadata

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventMetadata | Documentation

    Type alias EventMetadata

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagMetadata.html b/types/_openfeature_server_sdk.FlagMetadata.html index 03aca8f53..5e01bf9fc 100644 --- a/types/_openfeature_server_sdk.FlagMetadata.html +++ b/types/_openfeature_server_sdk.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation

    Type alias FlagMetadata

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

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.FlagValue.html b/types/_openfeature_server_sdk.FlagValue.html index 8562c46ca..479a08350 100644 --- a/types/_openfeature_server_sdk.FlagValue.html +++ b/types/_openfeature_server_sdk.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation

    Type alias FlagValue

    FlagValue: boolean | string | number | JsonValue

    Represents a JSON node value, or Date.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.Hook.html b/types/_openfeature_server_sdk.Hook.html index 348381b57..86faf198b 100644 --- a/types/_openfeature_server_sdk.Hook.html +++ b/types/_openfeature_server_sdk.Hook.html @@ -1 +1 @@ -Hook | Documentation

    Type alias Hook

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Hook | Documentation

    Type alias Hook

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.JsonObject.html b/types/_openfeature_server_sdk.JsonObject.html index 27a16a2da..074c52b88 100644 --- a/types/_openfeature_server_sdk.JsonObject.html +++ b/types/_openfeature_server_sdk.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Paradigm

    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ReconcilingEvent.html b/types/_openfeature_server_sdk.ReconcilingEvent.html index 565270a8d..c6c5481b1 100644 --- a/types/_openfeature_server_sdk.ReconcilingEvent.html +++ b/types/_openfeature_server_sdk.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias ResolutionDetails<U>

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

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

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

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ResolutionReason.html b/types/_openfeature_server_sdk.ResolutionReason.html index 698738349..09146f3e6 100644 --- a/types/_openfeature_server_sdk.ResolutionReason.html +++ b/types/_openfeature_server_sdk.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.TransactionContext.html b/types/_openfeature_server_sdk.TransactionContext.html index 6a4c55f53..e50811f52 100644 --- a/types/_openfeature_server_sdk.TransactionContext.html +++ b/types/_openfeature_server_sdk.TransactionContext.html @@ -1,4 +1,4 @@ TransactionContext | Documentation

    Type alias TransactionContext

    TransactionContext: EvaluationContext

    Transaction context is a mechanism for adding transaction specific context that is merged with evaluation context prior to flag evaluation. Examples of potential transaction specific context include: a user id, user agent, or request path.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.AnyProviderEvent.html b/types/_openfeature_web_sdk.AnyProviderEvent.html index f4808ee65..2d5f36177 100644 --- a/types/_openfeature_web_sdk.AnyProviderEvent.html +++ b/types/_openfeature_web_sdk.AnyProviderEvent.html @@ -1,3 +1,3 @@ AnyProviderEvent | Documentation

    Type alias AnyProviderEvent

    AnyProviderEvent: ServerProviderEvents | ProviderEvents

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.CommonEventDetails.html b/types/_openfeature_web_sdk.CommonEventDetails.html index 54e7b5378..897c47ebb 100644 --- a/types/_openfeature_web_sdk.CommonEventDetails.html +++ b/types/_openfeature_web_sdk.CommonEventDetails.html @@ -1,2 +1,2 @@ CommonEventDetails | Documentation

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: string

      Deprecated

      alias of "domain", use domain instead

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ConfigChangeEvent.html b/types/_openfeature_web_sdk.ConfigChangeEvent.html index 7dc8ba74c..e3c9555f5 100644 --- a/types/_openfeature_web_sdk.ConfigChangeEvent.html +++ b/types/_openfeature_web_sdk.ConfigChangeEvent.html @@ -1 +1 @@ -ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ConfigChangeEvent | Documentation

    Type alias ConfigChangeEvent

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

    Type declaration

    • Optional flagsChanged?: string[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ErrorEvent.html b/types/_openfeature_web_sdk.ErrorEvent.html index 25a009d73..4cf247232 100644 --- a/types/_openfeature_web_sdk.ErrorEvent.html +++ b/types/_openfeature_web_sdk.ErrorEvent.html @@ -1 +1 @@ -ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ErrorEvent | Documentation

    Type alias ErrorEvent

    ErrorEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationContext.html b/types/_openfeature_web_sdk.EvaluationContext.html index 22623e5b5..fdb132217 100644 --- a/types/_openfeature_web_sdk.EvaluationContext.html +++ b/types/_openfeature_web_sdk.EvaluationContext.html @@ -2,4 +2,4 @@

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationContextValue.html b/types/_openfeature_web_sdk.EvaluationContextValue.html index 733bf246c..5f2d48099 100644 --- a/types/_openfeature_web_sdk.EvaluationContextValue.html +++ b/types/_openfeature_web_sdk.EvaluationContextValue.html @@ -1 +1 @@ -EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationContextValue | Documentation

    Type alias EvaluationContextValue

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EvaluationDetails.html b/types/_openfeature_web_sdk.EvaluationDetails.html index 43b3bd236..c31dd8e83 100644 --- a/types/_openfeature_web_sdk.EvaluationDetails.html +++ b/types/_openfeature_web_sdk.EvaluationDetails.html @@ -1 +1 @@ -EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

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

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EvaluationDetails | Documentation

    Type alias EvaluationDetails<T>

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

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EventContext<U, T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<U, T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventDetails.html b/types/_openfeature_web_sdk.EventDetails.html index df7f63472..230462eaf 100644 --- a/types/_openfeature_web_sdk.EventDetails.html +++ b/types/_openfeature_web_sdk.EventDetails.html @@ -1 +1 @@ -EventDetails | Documentation

    Type alias EventDetails<T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventDetails | Documentation

    Type alias EventDetails<T>

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

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventHandler.html b/types/_openfeature_web_sdk.EventHandler.html index 0ea2e9dcd..8b48b5617 100644 --- a/types/_openfeature_web_sdk.EventHandler.html +++ b/types/_openfeature_web_sdk.EventHandler.html @@ -1 +1 @@ -EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventHandler | Documentation

    Type alias EventHandler<T>

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

    Type Parameters

    Type declaration

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

      • Parameters

        Returns Promise<unknown> | unknown

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventMetadata.html b/types/_openfeature_web_sdk.EventMetadata.html index e0df8fa2c..2118aee4e 100644 --- a/types/_openfeature_web_sdk.EventMetadata.html +++ b/types/_openfeature_web_sdk.EventMetadata.html @@ -1 +1 @@ -EventMetadata | Documentation

    Type alias EventMetadata

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventMetadata | Documentation

    Type alias EventMetadata

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

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagMetadata.html b/types/_openfeature_web_sdk.FlagMetadata.html index 4ac225e25..669c51909 100644 --- a/types/_openfeature_web_sdk.FlagMetadata.html +++ b/types/_openfeature_web_sdk.FlagMetadata.html @@ -1,3 +1,3 @@ FlagMetadata | Documentation

    Type alias FlagMetadata

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

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

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagValue.html b/types/_openfeature_web_sdk.FlagValue.html index dc8527392..8f419547d 100644 --- a/types/_openfeature_web_sdk.FlagValue.html +++ b/types/_openfeature_web_sdk.FlagValue.html @@ -1,2 +1,2 @@ FlagValue | Documentation

    Type alias FlagValue

    FlagValue: boolean | string | number | JsonValue

    Represents a JSON node value, or Date.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.FlagValueType.html b/types/_openfeature_web_sdk.FlagValueType.html index 510ed77ca..944317ffb 100644 --- a/types/_openfeature_web_sdk.FlagValueType.html +++ b/types/_openfeature_web_sdk.FlagValueType.html @@ -1 +1 @@ -FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +FlagValueType | Documentation

    Type alias FlagValueType

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Hook.html b/types/_openfeature_web_sdk.Hook.html index 3a15bf231..5bc47be81 100644 --- a/types/_openfeature_web_sdk.Hook.html +++ b/types/_openfeature_web_sdk.Hook.html @@ -1 +1 @@ -Hook | Documentation

    Type alias Hook

    Hook: BaseHook<FlagValue, void, void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Hook | Documentation

    Type alias Hook

    Hook: BaseHook<FlagValue, void, void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.HookHints.html b/types/_openfeature_web_sdk.HookHints.html index d3c33e9fb..9b9b7c5db 100644 --- a/types/_openfeature_web_sdk.HookHints.html +++ b/types/_openfeature_web_sdk.HookHints.html @@ -1 +1 @@ -HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +HookHints | Documentation

    Type alias HookHints

    HookHints: Readonly<Record<string, unknown>>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonArray.html b/types/_openfeature_web_sdk.JsonArray.html index b0f1b5d4c..3fda27b4c 100644 --- a/types/_openfeature_web_sdk.JsonArray.html +++ b/types/_openfeature_web_sdk.JsonArray.html @@ -1 +1 @@ -JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonArray | Documentation

    Type alias JsonArray

    JsonArray: JsonValue[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonObject.html b/types/_openfeature_web_sdk.JsonObject.html index 7631e069a..7568f2feb 100644 --- a/types/_openfeature_web_sdk.JsonObject.html +++ b/types/_openfeature_web_sdk.JsonObject.html @@ -1 +1 @@ -JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +JsonObject | Documentation

    Type alias JsonObject

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.JsonValue.html b/types/_openfeature_web_sdk.JsonValue.html index 92989902d..e29414eb8 100644 --- a/types/_openfeature_web_sdk.JsonValue.html +++ b/types/_openfeature_web_sdk.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.NotChangeEvents.html b/types/_openfeature_web_sdk.NotChangeEvents.html index 6aa432434..65c23dffe 100644 --- a/types/_openfeature_web_sdk.NotChangeEvents.html +++ b/types/_openfeature_web_sdk.NotChangeEvents.html @@ -1 +1 @@ -NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NotChangeEvents | Documentation

    Type alias NotChangeEvents

    NotChangeEvents: ServerNotChangeEvents | ClientNotChangeEvents

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Paradigm.html b/types/_openfeature_web_sdk.Paradigm.html index e6f6cb5aa..0c2d9e7cb 100644 --- a/types/_openfeature_web_sdk.Paradigm.html +++ b/types/_openfeature_web_sdk.Paradigm.html @@ -1,2 +1,2 @@ Paradigm | Documentation

    Type alias Paradigm

    Paradigm: "server" | "client"

    Defines where the library is intended to be run.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PrimitiveValue | Documentation

    Type alias PrimitiveValue

    PrimitiveValue: null | boolean | string | number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ProviderEmittableEvents.html b/types/_openfeature_web_sdk.ProviderEmittableEvents.html index cdc8afefa..4d3380d2a 100644 --- a/types/_openfeature_web_sdk.ProviderEmittableEvents.html +++ b/types/_openfeature_web_sdk.ProviderEmittableEvents.html @@ -1,2 +1,2 @@ ProviderEmittableEvents | Documentation

    Type alias ProviderEmittableEvents

    ProviderEmittableEvents: Exclude<ProviderEvents, ContextChanged>

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ReadyEvent.html b/types/_openfeature_web_sdk.ReadyEvent.html index 6450582fa..b8b40355f 100644 --- a/types/_openfeature_web_sdk.ReadyEvent.html +++ b/types/_openfeature_web_sdk.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ReconcilingEvent.html b/types/_openfeature_web_sdk.ReconcilingEvent.html index dac92b994..779bc884b 100644 --- a/types/_openfeature_web_sdk.ReconcilingEvent.html +++ b/types/_openfeature_web_sdk.ReconcilingEvent.html @@ -1 +1 @@ -ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReconcilingEvent | Documentation

    Type alias ReconcilingEvent

    ReconcilingEvent: CommonEventProps & {
        errorCode: ErrorCode;
    }

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ResolutionDetails.html b/types/_openfeature_web_sdk.ResolutionDetails.html index cca9ba105..d48c2d8e3 100644 --- a/types/_openfeature_web_sdk.ResolutionDetails.html +++ b/types/_openfeature_web_sdk.ResolutionDetails.html @@ -1 +1 @@ -ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

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

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionDetails | Documentation

    Type alias ResolutionDetails<U>

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

    Type Parameters

    • U

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ResolutionReason.html b/types/_openfeature_web_sdk.ResolutionReason.html index 38348d739..df1544acd 100644 --- a/types/_openfeature_web_sdk.ResolutionReason.html +++ b/types/_openfeature_web_sdk.ResolutionReason.html @@ -1 +1 @@ -ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ResolutionReason | Documentation

    Type alias ResolutionReason

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.StaleEvent.html b/types/_openfeature_web_sdk.StaleEvent.html index 61965a498..20abf8da2 100644 --- a/types/_openfeature_web_sdk.StaleEvent.html +++ b/types/_openfeature_web_sdk.StaleEvent.html @@ -1 +1 @@ -StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +StaleEvent | Documentation

    Type alias StaleEvent

    StaleEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_core.LOG_LEVELS.html b/variables/_openfeature_core.LOG_LEVELS.html index 3e0b27aa9..cafb85edc 100644 --- a/variables/_openfeature_core.LOG_LEVELS.html +++ b/variables/_openfeature_core.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_core.StandardResolutionReasons.html b/variables/_openfeature_core.StandardResolutionReasons.html index 4dc18c195..8106b4389 100644 --- a/variables/_openfeature_core.StandardResolutionReasons.html +++ b/variables/_openfeature_core.StandardResolutionReasons.html @@ -7,4 +7,4 @@
  • Readonly STATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • Readonly TARGETING_MATCH: "TARGETING_MATCH"

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

  • Readonly UNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.LOG_LEVELS.html b/variables/_openfeature_server_sdk.LOG_LEVELS.html index c360912f3..699397234 100644 --- a/variables/_openfeature_server_sdk.LOG_LEVELS.html +++ b/variables/_openfeature_server_sdk.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.NOOP_PROVIDER.html b/variables/_openfeature_server_sdk.NOOP_PROVIDER.html index aae6b3e09..5f262958f 100644 --- a/variables/_openfeature_server_sdk.NOOP_PROVIDER.html +++ b/variables/_openfeature_server_sdk.NOOP_PROVIDER.html @@ -1 +1 @@ -NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html b/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html index 1e1f433cc..db781ba25 100644 --- a/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html +++ b/variables/_openfeature_server_sdk.NOOP_TRANSACTION_CONTEXT_PROPAGATOR.html @@ -1 +1 @@ -NOOP_TRANSACTION_CONTEXT_PROPAGATOR | Documentation

    Variable NOOP_TRANSACTION_CONTEXT_PROPAGATORConst

    NOOP_TRANSACTION_CONTEXT_PROPAGATOR: NoopTransactionContextPropagator = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NOOP_TRANSACTION_CONTEXT_PROPAGATOR | Documentation

    Variable NOOP_TRANSACTION_CONTEXT_PROPAGATORConst

    NOOP_TRANSACTION_CONTEXT_PROPAGATOR: NoopTransactionContextPropagator = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.OpenFeature.html b/variables/_openfeature_server_sdk.OpenFeature.html index 01585f7e2..0dced6dc5 100644 --- a/variables/_openfeature_server_sdk.OpenFeature.html +++ b/variables/_openfeature_server_sdk.OpenFeature.html @@ -1,3 +1,3 @@ OpenFeature | Documentation

    Variable OpenFeatureConst

    OpenFeature: OpenFeatureAPI = ...

    A singleton instance of the OpenFeature API.

    Returns

    OpenFeature API

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_server_sdk.StandardResolutionReasons.html b/variables/_openfeature_server_sdk.StandardResolutionReasons.html index 3ef698d96..4156509f4 100644 --- a/variables/_openfeature_server_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_server_sdk.StandardResolutionReasons.html @@ -7,4 +7,4 @@
  • Readonly STATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • Readonly TARGETING_MATCH: "TARGETING_MATCH"

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

  • Readonly UNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.LOG_LEVELS.html b/variables/_openfeature_web_sdk.LOG_LEVELS.html index 0bb3b6048..62ec6cb4a 100644 --- a/variables/_openfeature_web_sdk.LOG_LEVELS.html +++ b/variables/_openfeature_web_sdk.LOG_LEVELS.html @@ -1 +1 @@ -LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +LOG_LEVELS | Documentation

    Variable LOG_LEVELSConst

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.NOOP_PROVIDER.html b/variables/_openfeature_web_sdk.NOOP_PROVIDER.html index 5acba5647..2b6c36fd4 100644 --- a/variables/_openfeature_web_sdk.NOOP_PROVIDER.html +++ b/variables/_openfeature_web_sdk.NOOP_PROVIDER.html @@ -1 +1 @@ -NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +NOOP_PROVIDER | Documentation

    Variable NOOP_PROVIDERConst

    NOOP_PROVIDER: NoopFeatureProvider = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.OpenFeature.html b/variables/_openfeature_web_sdk.OpenFeature.html index 00332644b..c98495bad 100644 --- a/variables/_openfeature_web_sdk.OpenFeature.html +++ b/variables/_openfeature_web_sdk.OpenFeature.html @@ -1,3 +1,3 @@ OpenFeature | Documentation

    Variable OpenFeatureConst

    OpenFeature: OpenFeatureAPI = ...

    A singleton instance of the OpenFeature API.

    Returns

    OpenFeature API

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/variables/_openfeature_web_sdk.StandardResolutionReasons.html b/variables/_openfeature_web_sdk.StandardResolutionReasons.html index 0cd3b9e63..c4902474a 100644 --- a/variables/_openfeature_web_sdk.StandardResolutionReasons.html +++ b/variables/_openfeature_web_sdk.StandardResolutionReasons.html @@ -7,4 +7,4 @@
  • Readonly STATIC: "STATIC"

    The resolved value is static (no dynamic evaluation).

  • Readonly TARGETING_MATCH: "TARGETING_MATCH"

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

  • Readonly UNKNOWN: "UNKNOWN"

    The reason for the resolved value could not be determined.

    -

    • Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file