diff --git a/assets/navigation.js b/assets/navigation.js index c495b3aa0..247a46d71 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA72ZbW/bNhSF/0rhz6mbZE3b5VMzx3nZktiI3WBAURiMRTtaZCmgZG/GsP8+mjJFUpL5ItzbL0ES6DxHr5fSOd//7RX0n6J33vuavdF0QUmxZvRDTtmGsvd59Pru/bvNSf9z/6x31HsjxQvfcpVF64TmH2aaYlYqZlzRfylWCd/6NU6j3vnpUW/+EicRo2nv/HvlNmQsY4MsogpL0/XqMLQSmPgv/x1VzDHLNnFE2XBD0yL3BZsqN31ScEQwvVQdpl/SBVknxV22XFKm4POE5LnlVBsyk35yqvOvErJ8yIqrbJ1G4lT6ezSkNp9rmlJGkkALXeWkx3NxqYaruChCzlWL2OZ1m97TVca28gr6G9WVdpcNSeJokKW7fwSethaxzWvEKVcl5WJ8629j6jwdBknMz3Mnk1Lq65OtVlna9Xgqtadb4AWqK31dOt3fBwA2zzFheegxKY2VvL/3+eB4pCTahpq0yW1+E7KgocNTaWzkKWFLWsTp8g+6vY/znP8WeDCHCFbX7Rvl265IMX8JtatLbT6/kZzeZNmrwsd8mLAFmVscpKi20p990sF0kTGx1X48hTnU1Tar+qjx4LeNmDboPS1IRArSAS6lVhMxfporjI+JIbWZDPkisSZFnKV38YIOtvOEBjm16O12/OD5LR7oUYps4P1sy4PAUmQF8xccdZCjt93PQJc2gs2y63Ph+UTUJ6EHuW0QmtB7kpIl7bLXhtJt0WHvdaHbYMpImpP57irtd4o/R29kSYqsi60NZ92ZLsPFZ6x0Gig+o0Ru02nP62KbEdgV6nptyvEqxtIl39840QZCwRdY12DWlTWf418/n5ydGl7pIl4OXki6LN/c/K1qQpeTeB0IslAKJ7uaf40R4bCoC4OdnvjftLOdUPt7Bt4ODaHbiZ/s4FOoNF784IPwv5vFtjckjRJ9AHnw9xovfnMAeRgcGDwNh91qHmqga3z4QbdsJfAm774Bguk7kcvB/Fawg1s+EVp5N7ER17mhQuAi/57zD3vGyNaXXAl8yKPnv+jc+/lUCh920L1RCVxk/t1Ooni58gXL7Z1cFq/iIt7QoN02VS6PMgMIWbeUws3Os2TdYbI3hP5OfO/4ZQs3KnUun0lBkrAXCaVwsZvvU74eTaXL6250PbsbPg3vJspjQ1hMnm3tg1KZ/F909MNoNJ6NH0dPt5fDxxC6IXQZTB8vHiYXg+nt6GE2GD1Mh39Od9rxxfXFdBRua8dZdkZLBkNMNZkFzu+dNCIsqt+leYjVQYjFOM7rQ3ixTsX9ddhHakzsp48GdlIwI7/wwZYaCzYTviP2LY3oIk5pFMJviC1GuWia7nfpH81rU8Dt1FRbrXYH3fGYGuKG0Q/Nymgn/6bPspo87n/sf1G2rdUk3xy4l5RE2FJSUhEayToaso6UbLQuUhpgFZGSj9dCGg5oFaR0we0flQte+Sg98JrHFgeU2rHNB6FzbLFBKhzbnKDbxmpaoVWN9XkI3zNKB9SSUZr8jIax8sKpFyUeqVus8BjFooTDt4omGaNSrBxw+8TqjQmrTFQGkE1i9eqBVyPqbzd4HaJ0AS4QJRa8PZRgpOrQxHvsffATC9vT1dcr2JKuTvefM95lgjlm8Nox5YNTjRlffgi9WHNO4pViB70QGrGmF3QdZiwA0F2YAYcuwgw4eAtm0MErMH31gu2/dDJw+dVAgzRf+hILU3vpRMDOS2KhCy+dC9l26Vy4qkv7yITuudR6ilBySThWw6X4mPVW0wW026q+vr2LrYCyqXrphW+aJNq3ZgppdlqSG5RaRzv3eJ2ONIEsdBQToc2RcOQqR9og9zjKpnOJM88YLRuc4/7piXJsrXB2GwP2NwIHW94IJEJzY3AhaxsBRutsBB2rsBFwvLZG4UOqmtAeRbh0L1F8Cwhhg9w+1D3ckb1vE1De/Wg1gPFwwXcAAo9aAAiHn5H+l0Y40b9gI+X+JTs89PcPz4QDXj5f4nHD+XI5xErm93R3LB9+YYHTbMEEj7IFFSnH1tiQIXaJDUiwA9GIQbP2vOClzHsTnIhZvZwi5Mu1Rx0vXG43QkiWa0bQsbKaXtCZsiJDB8qKDJ4mKzR4lFx9MsDmyBUWOEQ2ub4Jsjv0rRY2wMRXMKHj3goKmfVWULigV35DQKe8+5UMIeIVZKx8dw/HDHdrFqDJbvlNhRHrlm9/Pplu92xU7j1eMCocIFPRPRAhEhVk5DxUeCCHoXsPdxL643/yLDbbbksAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA72ZbW/bNhSF/0rhz6mbZG2X5VMzx3nZktiIvWBAURiMRTtaZCmgZHfGsP9emjJFUpL5ItzbL0ES6DxHr5fSOV//6xX036J33vuSvdF0QUmxZvRDTtmGsvd59Pru/bvNSf+sf9w76r2R4oVvucqidULzDzNNMSsVM67ovxSrhG/9GqdR7/z0qDd/iZOI0bR3/rVyGzKWsUEWUYWl6Xp1GFoJTPzZ/0cVc8yyTRxRNtzQtMh9wabKTZ8UHBFML1WH6Zd0QdZJcZctl5Qp+DwheW451YbMpJ+c6vyrhCwfsuIqW6eROJX+Hg2pzeeappSRJNBCVznp8VxcquEqLoqQc9Uitnndpvd0lbGtvIL+RnWl3WVDkjgaZOnuH4GnrUVs8xpxylVJuRjf+tuYOk+HQRLz89zJpJT6+mSrVZZ2PZ5K7ekWeIHqSl+XTvf3AYDNc0xYHnpMSmMl7+99PjgeKYm2oSZtcpvfhCxo6PBUGht5StiSFnG6/JNu7+M8578FHswhgtV1+0b5titSzF9C7epSm8/vJKc3Wfaq8DEfJmxB5hYHKaqt9J8+62C6yJjYaj+ewhzqaptVfdR48NtGTBv0nhYkIgXpAJdSq4kYP80VxsfEkNpMhnyRWJMiztK7eEEH23lCg5xa9HY7fvD8Fg/0KEU28H625UFgKbKC+QuOOsjR2+5noEsbwWbZ9bnwfCLqk9CD3DYITeg9ScmSdtlrQ+m26LD3utBtMGUkzcl8d5X2O8WfozeyJEXWxdaGs+5Ml+HiM1Y6DRSfUSK36bTndbHNCOwKdb025XgVY+mS72+caAOh4AusazDryprP8W+/nnw6NbzSRbwcvJB0Wb65+VvVhC4n8ToQZKEUTnY1/xojwmFRFwY7PfG/aWc7ofb3DLwdGkK3Ez/ZwadQabz4wQfhfzeLbW9IGiX6APLg7zVe/OYA8jA4MHgaDrvVPNRA1/jwg27ZSuBN3n0DBNN3IpeD+a1gB7d8IrTybmIjrnNDhcBF/iPnH/aMka0vuRL4kEfP/9C59/OpFD7soHujErjI/LudRPFy5QuW2zu5LF7FRbyhQbttqlweZQYQsm4phZudZ8m6w2RvCP2d+N7xyxZuVOpcPpOCJGEvEkrhYjffp3w9mkqX193oenY3fBreTZTHhrCYPNvaB6Uy+b/o6IfRaDwbP46ebi+HjyF0Q+gymD5ePEwuBtPb0cNsMHqYDv+e7rTji+uL6Sjc1o6z7IyWDIaYajILnN87aURYVL9L8xCrgxCLcZzXh/BinYr767CP1JjYzx8N7KRgRn7hgy01FmwmfEfsrzSiizilUQi/IbYY5aJput+lfzSvTQG3U1NttdoddMdjaogbRt80K6Od/E6fZTV53P/YP1O2rdUk3xy4l5RE2FJSUhEayToaso6UbLQuUhpgFZGSj9dCGg5oFaR0we0flQte+Sg98JrHFgeU2rHNB6FzbLFBKhzbnKDbxmpaoVWN9XkI3zNKB9SSUZr8jIax8sKpFyUeqVus8BjFooTDt4omGaNSrBxw+8TqjQmrTFQGkE1i9eqBVyPqbzd4HaJ0AS4QJRa8PZRgpOrQxHvsffATC9vT1dcr2JKuTvefM95lgjlm8Nox5YNTjRlffgi9WHNO4pViB70QGrGmF3QdZiwA0F2YAYcuwgw4eAtm0MErMH31gu2/dDJw+dVAgzRf+hILU3vpRMDOS2KhCy+dC9l26Vy4qkv7yITuudR6ilBySThWw6X4mPVW0wW026q+vr2LrYCyqXrphW+aJNq3ZgppdlqSG5RaRzv3eJ2ONIEsdBQToc2RcOQqR9og9zjKpnOJM88YLRuc4/7piXJsrXB2GwP2NwIHW94IJEJzY3AhaxsBRutsBB2rsBFwvLZG4UOqmtAeRbh0L1F8Cwhhg9w+1D3ckb1vE1De/Wg1gPFwwXcAAo9aAAiHn5H+l0Y40b9gI+X+JTs89PcPz4QDXj5f4nHD+XI5xErm93R3LB9+YYHTbMEEj7IFFSnH1tiQIXaJDUiwA9GIQbP2vOClzHsTnIhZvZwi5Mu1Rx0vXG43QkiWa0bQsbKaXtCZsiJDB8qKDJ4mKzR4lFx9MsDmyBUWOEQ2ub4Jsjv0rRY2wMRXMKHj3goKmfVWULigV35DQKe8+5UMIeIVZKx8dw/HDHdrFqDJbvlNhRHrlm9/Pplu92xU7j1eMCocIFPRPRAhEhVk5DxUeCCHoXsPdxL67Qc4w+SrbksAAA==" \ No newline at end of file diff --git a/classes/_openfeature_core.DefaultLogger.html b/classes/_openfeature_core.DefaultLogger.html index b6420186e..65826a28d 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 0f4b66335..835abf202 100644 --- a/classes/_openfeature_core.FlagNotFoundError.html +++ b/classes/_openfeature_core.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 90b87d5cc..4e2d6be17 100644 --- a/classes/_openfeature_core.GeneralError.html +++ b/classes/_openfeature_core.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 792974728..912a881b6 100644 --- a/classes/_openfeature_core.GenericEventEmitter.html +++ b/classes/_openfeature_core.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

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

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

Implements

Constructors

constructor +

Type Parameters

  • 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: WeakMap<EventHandler<any>, EventHandler<any>> = ...

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): GenericEventEmitter<AdditionalContext>

  • 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: WeakMap<EventHandler<any>, EventHandler<any>> = ...

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

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_core.InvalidContextError.html b/classes/_openfeature_core.InvalidContextError.html index c0b2e8ed2..8fedede5a 100644 --- a/classes/_openfeature_core.InvalidContextError.html +++ b/classes/_openfeature_core.InvalidContextError.html @@ -1,4 +1,4 @@ -InvalidContextError | Documentation

Class InvalidContextError

Hierarchy

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 300678bf1..d1f31ca5a 100644 --- a/classes/_openfeature_core.OpenFeatureCommonAPI.html +++ b/classes/_openfeature_core.OpenFeatureCommonAPI.html @@ -1,4 +1,4 @@ -OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Implements

Constructors

constructor

Properties

_clientEventHandlers _clientEvents _clientProviders @@ -29,59 +29,59 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected Abstract Readonly _events

_events: GenericEventEmitter<Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected Abstract Readonly _events

_events: GenericEventEmitter<Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

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

  • Adds a handler for the given provider event type. The handlers are called in the order they have been added. API (global) events run for all providers.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler<T>

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): OpenFeatureCommonAPI<P, H>

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

Returns void

addHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

Protected clearProvidersAndSetDefault

close

Private getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Private getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

setLogger

Returns void

Private setAwaitableProvider

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureErrorAbstract

Hierarchy

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 211423a05..c9d941983 100644 --- a/classes/_openfeature_core.ParseError.html +++ b/classes/_openfeature_core.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 5d3611320..2a6928a66 100644 --- a/classes/_openfeature_core.ProviderNotReadyError.html +++ b/classes/_openfeature_core.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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.SafeLogger.html b/classes/_openfeature_core.SafeLogger.html index 658c964c4..8a2f6c1c1 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 b58b9a335..622c12141 100644 --- a/classes/_openfeature_core.TargetingKeyMissingError.html +++ b/classes/_openfeature_core.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 cf2aecb97..2428a0071 100644 --- a/classes/_openfeature_core.TypeMismatchError.html +++ b/classes/_openfeature_core.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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.DefaultLogger.html b/classes/_openfeature_server_sdk.DefaultLogger.html index a2d1e6a02..b00856472 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 74e88840b..d42386fc2 100644 --- a/classes/_openfeature_server_sdk.FlagNotFoundError.html +++ b/classes/_openfeature_server_sdk.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 b496290f8..6f995693f 100644 --- a/classes/_openfeature_server_sdk.GeneralError.html +++ b/classes/_openfeature_server_sdk.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 162a71f96..de2c7ab5f 100644 --- a/classes/_openfeature_server_sdk.GenericEventEmitter.html +++ b/classes/_openfeature_server_sdk.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

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

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

Hierarchy

Implements

Constructors

constructor +

Type Parameters

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

Hierarchy

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: WeakMap<EventHandler<any>, EventHandler<any>> = ...

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): GenericEventEmitter<AdditionalContext>

  • 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: WeakMap<EventHandler<any>, EventHandler<any>> = ...

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

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.InMemoryProvider.html b/classes/_openfeature_server_sdk.InMemoryProvider.html index 578238d6d..06370451c 100644 --- a/classes/_openfeature_server_sdk.InMemoryProvider.html +++ b/classes/_openfeature_server_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

Class InMemoryProvider

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

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

+

Constructors

constructor

Properties

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "server" = 'server'

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

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "server" = 'server'

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

-

Methods

Private lookupFlagValue

putConfiguration

Methods

Private lookupFlagValue

putConfiguration

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns void

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class InvalidContextError

Hierarchy

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 be2300ad4..4fbea4e31 100644 --- a/classes/_openfeature_server_sdk.OpenFeatureAPI.html +++ b/classes/_openfeature_server_sdk.OpenFeatureAPI.html @@ -1,4 +1,4 @@ -OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy

Implements

Constructors

constructor +OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy

Implements

Constructors

constructor

Properties

_clientEvents _clientProviders _context @@ -31,30 +31,30 @@ setProviderAndWait setTransactionContext setTransactionContextPropagator -

Constructors

Private constructor

Properties

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _events

_events: OpenFeatureEventEmitter = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _events

_events: OpenFeatureEventEmitter = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Private _transactionContextPropagator

_transactionContextPropagator: TransactionContextPropagator = NOOP_TRANSACTION_CONTEXT_PROPAGATOR

Accessors

providerMetadata

Methods

Protected _createEventEmitter

addHandler

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

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

Methods

Protected _createEventEmitter

addHandler

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

  • Adds a handler for the given provider event type. The handlers are called in the order they have been added. API (global) events run for all providers.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler<T>

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): OpenFeatureAPI

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

Returns void

addHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

clearProviders

Protected clearProvidersAndSetDefault

close

getClient

clearProviders

Protected clearProvidersAndSetDefault

close

getClient

Returns Client

OpenFeature Client

-

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

getTransactionContext

getTransactionContext

removeHandler

removeHandler

setContext

Returns void

setContext

setLogger

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

setTransactionContext

setTransactionContext

setTransactionContextPropagator

Returns void

setTransactionContextPropagator

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureClient

Implements

Constructors

constructor +OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _context

_context: EvaluationContext

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

Methods

addHandler

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

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

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _context

_context: EvaluationContext

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

Methods

addHandler

addHooks

  • addHooks(...hooks): OpenFeatureClient

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

Returns void

addHooks

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

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

removeHandler

removeHandler

setContext

Returns void

setContext

setLogger

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

_clientEventHandlers _clientEvents _clientProviders @@ -29,59 +29,59 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected Abstract Readonly _events

_events: GenericEventEmitter<Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected Abstract Readonly _events

_events: GenericEventEmitter<Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

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

  • Adds a handler for the given provider event type. The handlers are called in the order they have been added. API (global) events run for all providers.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler<T>

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): OpenFeatureCommonAPI<P, H>

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

Returns void

addHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

Protected clearProvidersAndSetDefault

close

Private getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Private getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

setLogger

Returns void

Private setAwaitableProvider

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureErrorAbstract

Hierarchy

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 5f0378235..6b63a2099 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

Constructors

constructor +

Hierarchy

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): OpenFeatureEventEmitter

  • 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 5c7b4fd3d..a29b9bb0b 100644 --- a/classes/_openfeature_server_sdk.ParseError.html +++ b/classes/_openfeature_server_sdk.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 ef030fd22..260312e4d 100644 --- a/classes/_openfeature_server_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_server_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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.SafeLogger.html b/classes/_openfeature_server_sdk.SafeLogger.html index cd40e043b..1e5d68cf4 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 f540be631..5bd637c61 100644 --- a/classes/_openfeature_server_sdk.TargetingKeyMissingError.html +++ b/classes/_openfeature_server_sdk.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 f69d425b4..57265a63d 100644 --- a/classes/_openfeature_server_sdk.TypeMismatchError.html +++ b/classes/_openfeature_server_sdk.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 b2f8140e9..9490241d2 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 3ef5f1d10..fa78b844c 100644 --- a/classes/_openfeature_web_sdk.FlagNotFoundError.html +++ b/classes/_openfeature_web_sdk.FlagNotFoundError.html @@ -1,4 +1,4 @@ -FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy

Constructors

constructor +FlagNotFoundError | Documentation

Class FlagNotFoundError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 f563e4cad..7557c2046 100644 --- a/classes/_openfeature_web_sdk.GeneralError.html +++ b/classes/_openfeature_web_sdk.GeneralError.html @@ -1,4 +1,4 @@ -GeneralError | Documentation

Class GeneralError

Hierarchy

Constructors

constructor +GeneralError | Documentation

Class GeneralError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 a936a5ecc..2cc14e490 100644 --- a/classes/_openfeature_web_sdk.GenericEventEmitter.html +++ b/classes/_openfeature_web_sdk.GenericEventEmitter.html @@ -1,6 +1,6 @@ GenericEventEmitter | Documentation

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

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

Hierarchy

Implements

Constructors

constructor +

Type Parameters

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

Hierarchy

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: WeakMap<EventHandler<any>, EventHandler<any>> = ...

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): GenericEventEmitter<AdditionalContext>

  • 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: WeakMap<EventHandler<any>, EventHandler<any>> = ...

Protected Abstract Readonly eventEmitter

eventEmitter: PlatformEventEmitter

Private Optional Readonly globalLogger

globalLogger?: (() => Logger)

Type declaration

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.InMemoryProvider.html b/classes/_openfeature_web_sdk.InMemoryProvider.html index 8c9f76662..ba516e51f 100644 --- a/classes/_openfeature_web_sdk.InMemoryProvider.html +++ b/classes/_openfeature_web_sdk.InMemoryProvider.html @@ -1,5 +1,5 @@ InMemoryProvider | Documentation

Class InMemoryProvider

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

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private _context

_context: undefined | EvaluationContext

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

+

Constructors

constructor

Properties

Private _context

_context: undefined | EvaluationContext

Private _flagConfiguration

_flagConfiguration: FlagConfiguration

Readonly events

events: OpenFeatureEventEmitter = ...

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "client" = 'client'

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

Readonly metadata

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

Type declaration

  • Readonly name: "in-memory"

Readonly runsOn

runsOn: "client" = 'client'

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

-

status

status: ProviderStatus = ProviderStatus.NOT_READY

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

status

status: ProviderStatus = ProviderStatus.NOT_READY

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

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

-

Methods

initialize

Methods

initialize

Private lookupFlagValue

putConfiguration

Private lookupFlagValue

putConfiguration

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Private resolveAndCheckFlag

resolveBooleanEvaluation

Private resolveFlagWithReason

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class InvalidContextError

Hierarchy

Constructors

constructor +InvalidContextError | Documentation

Class InvalidContextError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 43a9ccec6..91b65f56b 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureAPI.html +++ b/classes/_openfeature_web_sdk.OpenFeatureAPI.html @@ -1,4 +1,4 @@ -OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy

Implements

Constructors

constructor +OpenFeatureAPI | Documentation

Class OpenFeatureAPI

Hierarchy

Implements

Constructors

constructor

Properties

_clientEvents _clientProviders _context @@ -31,29 +31,29 @@ setLogger setProvider setProviderAndWait -

Constructors

Private constructor

Properties

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _events

_events: OpenFeatureEventEmitter = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _namedProviderContext

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

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

Private constructor

Properties

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected _defaultProvider

_defaultProvider: Provider = NOOP_PROVIDER

Protected _events

_events: OpenFeatureEventEmitter = ...

Protected _hooks

_hooks: Hook[] = []

Protected _logger

_logger: Logger = ...

Protected _namedProviderContext

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

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected _createEventEmitter

addHandler

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

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

Methods

Protected _createEventEmitter

addHandler

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

  • Adds a handler for the given provider event type. The handlers are called in the order they have been added. API (global) events run for all providers.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler<T>

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): OpenFeatureAPI

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

Returns void

addHooks

Protected buildAndCacheEventEmitterForClient

clearContext

Protected buildAndCacheEventEmitterForClient

clearContext

clearContexts

Returns Promise<void>

clearContexts

clearHooks

clearHooks

clearProviders

Protected clearProvidersAndSetDefault

close

getClient

clearProviders

Protected clearProvidersAndSetDefault

close

getClient

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

removeHandler

removeHandler

Private runProviderContextChangeHandler

setContext

Returns void

Private runProviderContextChangeHandler

setContext

setLogger

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

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 397965dd7..1414a30e9 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureClient.html +++ b/classes/_openfeature_web_sdk.OpenFeatureClient.html @@ -1,4 +1,4 @@ -OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor +OpenFeatureClient | Documentation

Class OpenFeatureClient

Implements

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

providerStatus

Methods

addHandler

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

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

Constructors

constructor

Properties

Private Optional _clientLogger

_clientLogger?: Logger

Private _hooks

_hooks: Hook[] = []

Private Readonly emitterAccessor

emitterAccessor: (() => InternalEventEmitter)

Type declaration

    • (): InternalEventEmitter

    • Returns InternalEventEmitter

Private Readonly globalLogger

globalLogger: (() => Logger)

Type declaration

Private Readonly options

options: OpenFeatureClientOptions

Private Readonly providerAccessor

providerAccessor: (() => Provider)

Type declaration

Accessors

Private _logger

Private _provider

metadata

providerStatus

Methods

addHandler

addHooks

  • addHooks(...hooks): OpenFeatureClient

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

Returns void

addHooks

Private afterHooks

Private beforeHooks

clearHooks

Private afterHooks

Private beforeHooks

clearHooks

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

Private errorHooks

Private evaluate

Private finallyHooks

getBooleanDetails

getBooleanValue

getBooleanValue

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

removeHandler

removeHandler

setLogger

Returns void

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy

Implements

Constructors

constructor +OpenFeatureCommonAPI | Documentation

Class OpenFeatureCommonAPI<P, H>Abstract

Type Parameters

Hierarchy

Implements

Constructors

constructor

Properties

_clientEventHandlers _clientEvents _clientProviders @@ -29,59 +29,59 @@ setProvider setProviderAndWait transferListeners -

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected Abstract Readonly _events

_events: GenericEventEmitter<Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

  • get providerMetadata(): ProviderMetadata

  • Get metadata about the default provider.

    +

Constructors

constructor

Properties

Private Readonly _clientEventHandlers

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

Protected _clientEvents

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

Protected _clientProviders

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

Protected _context

_context: EvaluationContext = {}

Protected Abstract _defaultProvider

_defaultProvider: P

Protected Abstract Readonly _events

_events: GenericEventEmitter<Record<string, unknown>>

Protected _hooks

_hooks: H[] = []

Protected _logger

_logger: Logger = ...

Protected _runsOn

_runsOn: Paradigm

Accessors

providerMetadata

Methods

Protected Abstract _createEventEmitter

addHandler

Methods

Protected Abstract _createEventEmitter

addHandler

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

  • Adds a handler for the given provider event type. The handlers are called in the order they have been added. API (global) events run for all providers.

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler<T>

      The handler to run on occurrence of the event type

      -

    Returns void

addHooks

  • addHooks(...hooks): OpenFeatureCommonAPI<P, H>

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

Returns void

addHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

Protected buildAndCacheEventEmitterForClient

clearHooks

Protected clearProvidersAndSetDefault

close

Private getAssociatedEventEmitters

getHandlers

Protected clearProvidersAndSetDefault

close

Private getAssociatedEventEmitters

getHandlers

getHooks

getHooks

Protected getProviderForClient

getProviderMetadata

Protected getProviderForClient

getProviderMetadata

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private getUnboundEmitters

Private handleShutdownError

removeHandler

Private setAwaitableProvider

setLogger

Returns void

Private setAwaitableProvider

setLogger

setProvider

setProvider

setProviderAndWait

setProviderAndWait

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Private transferListeners

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/_openfeature_web_sdk.OpenFeatureError.html b/classes/_openfeature_web_sdk.OpenFeatureError.html index 7098e5afe..6994e089f 100644 --- a/classes/_openfeature_web_sdk.OpenFeatureError.html +++ b/classes/_openfeature_web_sdk.OpenFeatureError.html @@ -1,4 +1,4 @@ -OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy

Constructors

constructor +OpenFeatureError | Documentation

Class OpenFeatureErrorAbstract

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

Abstract code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 ee3f7673f..2fe9e49fe 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

Constructors

constructor +

Hierarchy

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): OpenFeatureEventEmitter

  • 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_web_sdk.ParseError.html b/classes/_openfeature_web_sdk.ParseError.html index 5f71f96f4..f0774155d 100644 --- a/classes/_openfeature_web_sdk.ParseError.html +++ b/classes/_openfeature_web_sdk.ParseError.html @@ -1,4 +1,4 @@ -ParseError | Documentation

Class ParseError

Hierarchy

Constructors

constructor +ParseError | Documentation

Class ParseError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 fd2a4a5e8..cf88a70c5 100644 --- a/classes/_openfeature_web_sdk.ProviderNotReadyError.html +++ b/classes/_openfeature_web_sdk.ProviderNotReadyError.html @@ -1,4 +1,4 @@ -ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy

Constructors

constructor +ProviderNotReadyError | Documentation

Class ProviderNotReadyError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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.SafeLogger.html b/classes/_openfeature_web_sdk.SafeLogger.html index 444861c07..49dadebf2 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 3bdbcfc59..444e2b98b 100644 --- a/classes/_openfeature_web_sdk.TargetingKeyMissingError.html +++ b/classes/_openfeature_web_sdk.TargetingKeyMissingError.html @@ -1,4 +1,4 @@ -TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy

Constructors

constructor +TargetingKeyMissingError | Documentation

Class TargetingKeyMissingError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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 2af95351a..142f6ba7d 100644 --- a/classes/_openfeature_web_sdk.TypeMismatchError.html +++ b/classes/_openfeature_web_sdk.TypeMismatchError.html @@ -1,4 +1,4 @@ -TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy

Constructors

constructor +TypeMismatchError | Documentation

Class TypeMismatchError

Hierarchy

Constructors

constructor

Properties

code message name @@ -6,7 +6,7 @@ prepareStackTrace? stackTraceLimit

Methods

captureStackTrace -

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Constructors

constructor

Properties

code

code: ErrorCode

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

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

Type declaration

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.ErrorCode.html b/enums/_openfeature_core.ErrorCode.html index e42ab363d..cf4967acd 100644 --- a/enums/_openfeature_core.ErrorCode.html +++ b/enums/_openfeature_core.ErrorCode.html @@ -1,4 +1,4 @@ -ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

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

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_core.ProviderEvents.html b/enums/_openfeature_core.ProviderEvents.html index 7517e4923..19195bc12 100644 --- a/enums/_openfeature_core.ProviderEvents.html +++ b/enums/_openfeature_core.ProviderEvents.html @@ -1,9 +1,9 @@ -ProviderEvents | Documentation

Enumeration ProviderEvents

Enumeration Members

ConfigurationChanged +ProviderEvents | Documentation

Enumeration ProviderEvents

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.ProviderStatus.html b/enums/_openfeature_core.ProviderStatus.html index 6b4fe8f24..ec444ad3a 100644 --- a/enums/_openfeature_core.ProviderStatus.html +++ b/enums/_openfeature_core.ProviderStatus.html @@ -1,10 +1,10 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

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

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_server_sdk.ProviderEvents.html b/enums/_openfeature_server_sdk.ProviderEvents.html index d5d307486..e4fbc10d6 100644 --- a/enums/_openfeature_server_sdk.ProviderEvents.html +++ b/enums/_openfeature_server_sdk.ProviderEvents.html @@ -1,9 +1,9 @@ -ProviderEvents | Documentation

Enumeration ProviderEvents

Enumeration Members

ConfigurationChanged +ProviderEvents | Documentation

Enumeration ProviderEvents

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 7b0f0b6cb..bc32fd279 100644 --- a/enums/_openfeature_server_sdk.ProviderStatus.html +++ b/enums/_openfeature_server_sdk.ProviderStatus.html @@ -1,10 +1,10 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration ErrorCode

Enumeration Members

FLAG_NOT_FOUND +ErrorCode | Documentation

Enumeration ErrorCode

Enumeration Members

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

Enumeration Members

FLAG_NOT_FOUND

FLAG_NOT_FOUND: "FLAG_NOT_FOUND"

The flag could not be found.

-

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

-

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

-

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

-

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

-

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

-

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

GENERAL

GENERAL: "GENERAL"

An error with an unspecified code.

+

INVALID_CONTEXT

INVALID_CONTEXT: "INVALID_CONTEXT"

The evaluation context does not meet provider requirements.

+

PARSE_ERROR

PARSE_ERROR: "PARSE_ERROR"

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

+

PROVIDER_NOT_READY

PROVIDER_NOT_READY: "PROVIDER_NOT_READY"

The value was resolved before the provider was ready.

+

TARGETING_KEY_MISSING

TARGETING_KEY_MISSING: "TARGETING_KEY_MISSING"

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

+

TYPE_MISMATCH

TYPE_MISMATCH: "TYPE_MISMATCH"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/_openfeature_web_sdk.ProviderEvents.html b/enums/_openfeature_web_sdk.ProviderEvents.html index e341e1b2e..3e7b9145f 100644 --- a/enums/_openfeature_web_sdk.ProviderEvents.html +++ b/enums/_openfeature_web_sdk.ProviderEvents.html @@ -1,9 +1,9 @@ -ProviderEvents | Documentation

Enumeration ProviderEvents

Enumeration Members

ConfigurationChanged +ProviderEvents | Documentation

Enumeration ProviderEvents

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.ProviderStatus.html b/enums/_openfeature_web_sdk.ProviderStatus.html index 685b0458f..1c74bb8eb 100644 --- a/enums/_openfeature_web_sdk.ProviderStatus.html +++ b/enums/_openfeature_web_sdk.ProviderStatus.html @@ -1,10 +1,10 @@ ProviderStatus | Documentation

Enumeration ProviderStatus

The state of the provider.

-

Enumeration Members

ERROR +

Enumeration Members

ERROR NOT_READY READY STALE

Enumeration Members

ERROR

ERROR: "ERROR"

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

-

NOT_READY

NOT_READY: "NOT_READY"

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

-

READY

READY: "READY"

The provider is ready to resolve flags.

-

STALE

STALE: "STALE"

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

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

NOT_READY

NOT_READY: "NOT_READY"

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

+

READY

READY: "READY"

The provider is ready to resolve flags.

+

STALE

STALE: "STALE"

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

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.isObject.html b/functions/_openfeature_core.isObject.html index 45383c93d..04ad9106e 100644 --- a/functions/_openfeature_core.isObject.html +++ b/functions/_openfeature_core.isObject.html @@ -1,4 +1,4 @@ isObject | Documentation

Function isObject

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

  • Checks whether the parameter is an object.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns value is T

    True if the value is an object

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.isString.html b/functions/_openfeature_core.isString.html index 41178bd17..6def20fda 100644 --- a/functions/_openfeature_core.isString.html +++ b/functions/_openfeature_core.isString.html @@ -1,4 +1,4 @@ isString | Documentation

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    Parameters

    • value: unknown

      The value to check

    Returns value is string

    True if the value is a string

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/functions/_openfeature_core.objectOrUndefined.html b/functions/_openfeature_core.objectOrUndefined.html index 0d6117dc8..687e4207a 100644 --- a/functions/_openfeature_core.objectOrUndefined.html +++ b/functions/_openfeature_core.objectOrUndefined.html @@ -1,4 +1,4 @@ objectOrUndefined | Documentation

Function objectOrUndefined

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

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

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns T | undefined

    The parameter if it is an object, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Parameters

Returns boolean

boolean indicating if the provider status corresponds to the event.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

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

    Parameters

    • value: unknown

      The value to check

    Returns string | undefined

    The parameter if it is a string, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isObject

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

  • Checks whether the parameter is an object.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns value is T

    True if the value is an object

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    Parameters

    • value: unknown

      The value to check

    Returns value is string

    True if the value is a string

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function objectOrUndefined

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

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

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns T | undefined

    The parameter if it is an object, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Parameters

Returns boolean

boolean indicating if the provider status corresponds to the event.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

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

    Parameters

    • value: unknown

      The value to check

    Returns string | undefined

    The parameter if it is a string, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isObject

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

  • Checks whether the parameter is an object.

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns value is T

    True if the value is an object

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function isString

  • isString(value): value is string

  • Checks whether the parameter is a string.

    Parameters

    • value: unknown

      The value to check

    Returns value is string

    True if the value is a string

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function objectOrUndefined

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

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

    Type Parameters

    • T extends object

    Parameters

    • value: unknown

      The value to check

    Returns T | undefined

    The parameter if it is an object, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Parameters

Returns boolean

boolean indicating if the provider status corresponds to the event.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function stringOrUndefined

  • stringOrUndefined(value): string | undefined

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

    Parameters

    • value: unknown

      The value to check

    Returns string | undefined

    The parameter if it is a string, otherwise undefined

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/index.html b/index.html index 7a066d4b8..75cb2a017 100644 --- a/index.html +++ b/index.html @@ -40,4 +40,4 @@

OpenFeature JavaScript SDKs

Made with contrib.rocks.

📜 License

Apache License 2.0

FOSSA Status

-

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.BaseHook.html b/interfaces/_openfeature_core.BaseHook.html index 3ea353d84..6b4bf6b80 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 {
    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 {
    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

  • after(hookContext, evaluationDetails, hookHints?): HooksReturn

  • Runs after flag values are successfully resolved from the provider.

    -

    Parameters

    Returns HooksReturn

Optional before

Optional before

  • before(hookContext, hookHints?): BeforeHookReturn

  • Runs before flag values are resolved from the provider. If an EvaluationContext is returned, it will be merged with the pre-existing EvaluationContext.

    -

    Parameters

    Returns BeforeHookReturn

Optional error

  • error(hookContext, error, hookHints?): HooksReturn

  • Runs in the event of an unhandled error or promise rejection during flag resolution, or any attached hooks.

    -

    Parameters

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

    Returns HooksReturn

Optional finally

  • finally(hookContext, hookHints?): HooksReturn

  • Runs after all other hook stages, regardless of success or error. +

    Parameters

    Returns BeforeHookReturn

Optional error

  • error(hookContext, error, hookHints?): HooksReturn

  • Runs in the event of an unhandled error or promise rejection during flag resolution, or any attached hooks.

    +

    Parameters

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

    Returns HooksReturn

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 595f9ab3b..3fdffaba0 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

Properties

clientMetadata +BeforeHookContext | Documentation

Interface BeforeHookContext

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

Hierarchy

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 6b9da7d62..9877f96c9 100644 --- a/interfaces/_openfeature_core.ClientMetadata.html +++ b/interfaces/_openfeature_core.ClientMetadata.html @@ -1,4 +1,4 @@ -ClientMetadata | Documentation

Interface ClientMetadata

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

Hierarchy

Properties

name? +ClientMetadata | Documentation

Interface ClientMetadata

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

Hierarchy

Properties

name? providerMetadata version? -

Properties

Optional Readonly name

name?: string

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 name

name?: string

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 207d4ab98..df3304837 100644 --- a/interfaces/_openfeature_core.CommonProvider.html +++ b/interfaces/_openfeature_core.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

Interface CommonProvider

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

Properties

events? +CommonProvider | Documentation

Interface CommonProvider

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

Properties

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

Properties

Optional events

events?: GenericEventEmitter<Record<string, unknown>>

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

-

Optional Readonly status

status?: ProviderStatus

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

Optional Readonly status

status?: ProviderStatus

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

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

-

Methods

Optional initialize

Methods

Optional initialize

  • initialize(context?): Promise<void>

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

    -

    Parameters

    Returns Promise<void>

Optional onClose

Optional onClose

  • onClose(): Promise<void>

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

    -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface EvaluationLifeCycle<T>

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

Type Parameters

  • T

Implemented by

Methods

addHooks +EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

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

Type Parameters

  • T

Implemented by

Methods

addHooks clearHooks getHooks

Methods

addHooks

  • addHooks(...hooks): T

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

    Parameters

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

      A list of hooks that should always run

    Returns T

    The receiver (this object)

    -

clearHooks

clearHooks

getHooks

getHooks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Interface Eventing

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

Implemented by

Methods

addHandler +Eventing | Documentation

Interface Eventing

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

Implemented by

Methods

addHandler getHandlers removeHandler

Methods

addHandler

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

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

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler<T>

      The handler to run on occurrence of the event type

      -

    Returns void

getHandlers

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

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

    +

Returns void

getHandlers

removeHandler

removeHandler

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

  • Removes a handler for the given provider event type.

    Type Parameters

    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 +

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 80e2ba92a..497087b2d 100644 --- a/interfaces/_openfeature_core.HookContext.html +++ b/interfaces/_openfeature_core.HookContext.html @@ -1,8 +1,8 @@ -HookContext | Documentation

Interface HookContext<T>

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

Type Parameters

Hierarchy

Properties

clientMetadata +HookContext | Documentation

Interface HookContext<T>

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

Type Parameters

Hierarchy

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 7303f1a40..fa60ead83 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 6a219a9f7..5f8c89d1d 100644 --- a/interfaces/_openfeature_core.ManageContext.html +++ b/interfaces/_openfeature_core.ManageContext.html @@ -1,9 +1,9 @@ -ManageContext | Documentation

Interface ManageContext<T>

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

Type Parameters

  • T

Methods

getContext +ManageContext | Documentation

Interface ManageContext<T>

interface ManageContext {
    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 3c2fd0cac..d7c745315 100644 --- a/interfaces/_openfeature_core.ManageLogger.html +++ b/interfaces/_openfeature_core.ManageLogger.html @@ -1,8 +1,8 @@ -ManageLogger | Documentation

Interface ManageLogger<T>

interface ManageLogger {
    setLogger(logger): T;
}

Type Parameters

  • T

Implemented by

Methods

setLogger +ManageLogger | Documentation

Interface ManageLogger<T>

interface ManageLogger {
    setLogger(logger): T;
}

Type Parameters

  • T

Implemented by

Methods

setLogger

Methods

setLogger

  • setLogger(logger): T

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

    Parameters

    • logger: Logger

      The logger to be used

    Returns T

    The receiver (this object)

    -

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_core.Metadata.html b/interfaces/_openfeature_core.Metadata.html index 348aed316..8e380e314 100644 --- a/interfaces/_openfeature_core.Metadata.html +++ b/interfaces/_openfeature_core.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

Interface Metadata

interface Metadata {}

Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Metadata | Documentation

Interface Metadata

interface Metadata {}

Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Interface ProviderMetadata

Static data about the provider.

-
interface ProviderMetadata {
    name: string;
}

Hierarchy

Properties

name -

Properties

Readonly name

name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Hierarchy

Properties

name +

Properties

Readonly name

name: string

Settings

Member Visibility

Theme

On This Page

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 de2310ab7..cbfdc0eed 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 {
    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 {
    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

  • after(hookContext, evaluationDetails, hookHints?): HooksReturn

  • Runs after flag values are successfully resolved from the provider.

    -

    Parameters

    Returns HooksReturn

Optional before

Optional before

  • before(hookContext, hookHints?): BeforeHookReturn

  • Runs before flag values are resolved from the provider. If an EvaluationContext is returned, it will be merged with the pre-existing EvaluationContext.

    -

    Parameters

    Returns BeforeHookReturn

Optional error

  • error(hookContext, error, hookHints?): HooksReturn

  • Runs in the event of an unhandled error or promise rejection during flag resolution, or any attached hooks.

    -

    Parameters

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

    Returns HooksReturn

Optional finally

  • finally(hookContext, hookHints?): HooksReturn

  • Runs after all other hook stages, regardless of success or error. +

    Parameters

    Returns BeforeHookReturn

Optional error

  • error(hookContext, error, hookHints?): HooksReturn

  • Runs in the event of an unhandled error or promise rejection during flag resolution, or any attached hooks.

    +

    Parameters

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

    Returns HooksReturn

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 82cce9143..99a3e8f9c 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

Properties

clientMetadata +BeforeHookContext | Documentation

Interface BeforeHookContext

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

Hierarchy

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 404419e15..d63110ee9 100644 --- a/interfaces/_openfeature_server_sdk.Client.html +++ b/interfaces/_openfeature_server_sdk.Client.html @@ -1,4 +1,4 @@ -Client | Documentation

Interface Client

interface Client {
    metadata: ClientMetadata;
    addHandler<T>(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<T>(eventType): EventHandler<T>[];
    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<T>(eventType, handler): void;
    setContext(context): Client;
    setLogger(logger): Client;
}

Hierarchy

Implemented by

Properties

metadata +Client | Documentation

Interface Client

interface Client {
    metadata: ClientMetadata;
    addHandler<T>(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<T>(eventType): EventHandler<T>[];
    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<T>(eventType, handler): void;
    setContext(context): Client;
    setLogger(logger): Client;
}

Hierarchy

Implemented by

Properties

metadata

Methods

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

Properties

Readonly metadata

metadata: ClientMetadata

Methods

addHandler

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

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

Properties

Readonly metadata

metadata: ClientMetadata

Methods

addHandler

addHooks

  • addHooks(...hooks): Client

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

Returns void

addHooks

clearHooks

clearHooks

getBooleanDetails

getBooleanDetails

getBooleanValue

getBooleanValue

getContext

getContext

getHandlers

getHandlers

getHooks

getHooks

getNumberDetails

getNumberDetails

getNumberValue

getNumberValue

getObjectDetails

getObjectDetails

getObjectValue

getObjectValue

getStringDetails

getStringDetails

getStringValue

getStringValue

removeHandler

removeHandler

setContext

Returns void

setContext

setLogger

setLogger

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.ClientMetadata.html b/interfaces/_openfeature_server_sdk.ClientMetadata.html index 52e748dfa..2193cccce 100644 --- a/interfaces/_openfeature_server_sdk.ClientMetadata.html +++ b/interfaces/_openfeature_server_sdk.ClientMetadata.html @@ -1,4 +1,4 @@ -ClientMetadata | Documentation

Interface ClientMetadata

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

Hierarchy

Properties

name? +ClientMetadata | Documentation

Interface ClientMetadata

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

Hierarchy

Properties

name? providerMetadata version? -

Properties

Optional Readonly name

name?: string

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 name

name?: string

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 5090797a1..54f2cbab3 100644 --- a/interfaces/_openfeature_server_sdk.CommonProvider.html +++ b/interfaces/_openfeature_server_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

Interface CommonProvider

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

Hierarchy

Properties

events? +CommonProvider | Documentation

Interface CommonProvider

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

Hierarchy

Properties

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

Properties

Optional events

events?: GenericEventEmitter<Record<string, unknown>>

An event emitter for ProviderEvents.

See

ProviderEvents

-

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

Readonly metadata

metadata: ProviderMetadata

Optional Readonly runsOn

runsOn?: Paradigm

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

-

Optional Readonly status

status?: ProviderStatus

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

Optional Readonly status

status?: ProviderStatus

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

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

-

Methods

Optional initialize

Methods

Optional initialize

  • initialize(context?): Promise<void>

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

    -

    Parameters

    Returns Promise<void>

Optional onClose

Optional onClose

  • onClose(): Promise<void>

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

    -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_server_sdk.EvaluationLifeCycle.html index b5c8c6be2..96424b055 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 {
    addHooks(...hooks): T;
    clearHooks(): T;
    getHooks(): BaseHook<FlagValue, unknown, unknown>[];
}

Type Parameters

  • T

Hierarchy

Implemented by

Methods

addHooks +EvaluationLifeCycle | Documentation

Interface EvaluationLifeCycle<T>

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

Type Parameters

  • T

Hierarchy

Implemented by

Methods

addHooks clearHooks getHooks

Methods

addHooks

  • addHooks(...hooks): T

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

    Parameters

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

      A list of hooks that should always run

    Returns T

    The receiver (this object)

    -

clearHooks

clearHooks

getHooks

getHooks

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Eventing.html b/interfaces/_openfeature_server_sdk.Eventing.html index 878349b54..f09a8b2d9 100644 --- a/interfaces/_openfeature_server_sdk.Eventing.html +++ b/interfaces/_openfeature_server_sdk.Eventing.html @@ -1,14 +1,14 @@ -Eventing | Documentation

Interface Eventing

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

Hierarchy

Implemented by

Methods

addHandler +Eventing | Documentation

Interface Eventing

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

Hierarchy

Implemented by

Methods

addHandler getHandlers removeHandler

Methods

addHandler

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

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

    Type Parameters

    Parameters

    • eventType: T

      The provider event type to listen to

    • handler: EventHandler<T>

      The handler to run on occurrence of the event type

      -

    Returns void

getHandlers

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

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

    +

Returns void

getHandlers

removeHandler

removeHandler

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

  • Removes a handler for the given provider event type.

    Type Parameters

    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 +

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 7d509cbb0..72bd0d47d 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

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

Methods

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

    The evaluation context used on an individual flag evaluation

  • Optional options: FlagEvaluationOptions

    Additional flag evaluation options

    • Returns Promise<EvaluationDetails<boolean>>

    Flag evaluation details response

    -

    getBooleanValue

    getBooleanValue

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

    • Performs a flag evaluation that returns a boolean.

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

      • defaultValue: boolean

        The value returned if an error occurs

      • Optional context: EvaluationContext

        The evaluation context used on an individual flag evaluation

      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns Promise<boolean>

      Flag evaluation response

      -

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

  • Type Parameters

    • T extends string = string

    Parameters

    Returns Promise<T>

    • Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_server_sdk.FlagEvaluationOptions.html index 0af3d8fe3..f0e568c3e 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 bfbbe6c57..5f6ac1085 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 {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy

    Properties

    clientMetadata +HookContext | Documentation

    Interface HookContext<T>

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

    Type Parameters

    Hierarchy

    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 79b697f6a..d37f783b8 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 25c1f55fa..4cec38127 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 {
        getContext(): EvaluationContext;
        setContext(context): T;
    }

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    getContext +ManageContext | Documentation

    Interface ManageContext<T>

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

    Type Parameters

    • T

    Hierarchy

    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 6ad615ba1..1b8db58ec 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 {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation

    Interface ManageLogger<T>

    interface ManageLogger {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    setLogger

    Methods

    setLogger

    • setLogger(logger): T

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

      Parameters

      • logger: Logger

        The logger to be used

      Returns T

      The receiver (this object)

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ManageTransactionContextPropagator<T>

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

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    getTransactionContext +ManageTransactionContextPropagator | Documentation

    Interface ManageTransactionContextPropagator<T>

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

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    getTransactionContext setTransactionContext setTransactionContextPropagator

    Methods

    getTransactionContext

    setTransactionContext

    setTransactionContext

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

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

      Sets the transaction context using the registered transaction context propagator.

      Type Parameters

      • R

        The return value of the callback

      Parameters

      • transactionContext: EvaluationContext

        The transaction specific context

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

        Callback function used to set the transaction context on the stack

          • (...args): R

          • Parameters

            • Rest ...args: unknown[]

            Returns R

      • Rest ...args: unknown[]

        Optional arguments that are passed to the callback function

        -

      Returns void

    setTransactionContextPropagator

    • setTransactionContextPropagator(transactionContextPropagator): T
    • Experimental

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

    Returns void

    setTransactionContextPropagator

    • setTransactionContextPropagator(transactionContextPropagator): T
    • Experimental

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

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

      Parameters

      Returns T

      The receiver (this object)

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_server_sdk.Metadata.html b/interfaces/_openfeature_server_sdk.Metadata.html index 0d1de2eef..45e7601a9 100644 --- a/interfaces/_openfeature_server_sdk.Metadata.html +++ b/interfaces/_openfeature_server_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy

    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 ae41bdbe4..ac348cbc2 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?: GenericEventEmitter<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

    Implemented by

    Properties

    events? +
    interface Provider {
        events?: GenericEventEmitter<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

    Implemented by

    Properties

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

    Properties

    Optional events

    events?: GenericEventEmitter<Record<string, unknown>>

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Optional Readonly hooks

    hooks?: Hook[]

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

    Optional Readonly hooks

    hooks?: Hook[]

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

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    -

    Optional Readonly status

    status?: ProviderStatus

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

    Optional Readonly status

    status?: ProviderStatus

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

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

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

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

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProviderMetadata

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Hierarchy

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    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 247d67a7c..f9d36074b 100644 --- a/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html +++ b/interfaces/_openfeature_server_sdk.TransactionContextPropagator.html @@ -1,15 +1,15 @@ -TransactionContextPropagator | Documentation

    Interface TransactionContextPropagator

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

    Hierarchy

    Methods

    getTransactionContext +TransactionContextPropagator | Documentation

    Interface TransactionContextPropagator

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

    Hierarchy

    Methods

    getTransactionContext setTransactionContext

    Methods

    getTransactionContext

    setTransactionContext

    setTransactionContext

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

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

      Sets the transaction context using the registered transaction context propagator.

      Type Parameters

      • R

        The return value of the callback

      Parameters

      • transactionContext: EvaluationContext

        The transaction specific context

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

        Callback function used to set the transaction context on the stack

          • (...args): R

          • Parameters

            • Rest ...args: unknown[]

            Returns R

      • Rest ...args: unknown[]

        Optional arguments that are passed to the callback function

        -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.BaseHook.html b/interfaces/_openfeature_web_sdk.BaseHook.html index 56b046882..761718422 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 {
        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 {
        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

    • after(hookContext, evaluationDetails, hookHints?): HooksReturn

    • Runs after flag values are successfully resolved from the provider.

      -

      Parameters

      Returns HooksReturn

    Optional before

    Optional before

    • before(hookContext, hookHints?): BeforeHookReturn

    • Runs before flag values are resolved from the provider. If an EvaluationContext is returned, it will be merged with the pre-existing EvaluationContext.

      -

      Parameters

      Returns BeforeHookReturn

    Optional error

    • error(hookContext, error, hookHints?): HooksReturn

    • Runs in the event of an unhandled error or promise rejection during flag resolution, or any attached hooks.

      -

      Parameters

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

      Returns HooksReturn

    Optional finally

    • finally(hookContext, hookHints?): HooksReturn

    • Runs after all other hook stages, regardless of success or error. +

      Parameters

      Returns BeforeHookReturn

    Optional error

    • error(hookContext, error, hookHints?): HooksReturn

    • Runs in the event of an unhandled error or promise rejection during flag resolution, or any attached hooks.

      +

      Parameters

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

      Returns HooksReturn

    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 81a2099bf..de650168f 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

    Properties

    clientMetadata +BeforeHookContext | Documentation

    Interface BeforeHookContext

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

    Hierarchy

    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 245625cec..255a1442f 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<T>(eventType, handler): void;
        addHooks(...hooks): Client;
        clearHooks(): Client;
        getBooleanDetails(flagKey, defaultValue, options?): EvaluationDetails<boolean>;
        getBooleanValue(flagKey, defaultValue, options?): boolean;
        getHandlers<T>(eventType): EventHandler<T>[];
        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<T>(eventType, handler): void;
        setLogger(logger): Client;
    }

    Hierarchy

    Implemented by

    Properties

    metadata +Client | Documentation

    Interface Client

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

    Hierarchy

    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<T>(eventType, handler): void

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

    Properties

    Readonly metadata

    metadata: ClientMetadata

    Readonly providerStatus

    providerStatus: ProviderStatus

    Returns the status of the associated provider.

    +

    Methods

    addHandler

    addHooks

    • addHooks(...hooks): Client

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

    Returns void

    addHooks

    clearHooks

    clearHooks

    getBooleanDetails

    getBooleanDetails

    getBooleanValue

    getBooleanValue

    getHandlers

    getHandlers

    getHooks

    getHooks

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    removeHandler

    removeHandler

    setLogger

    Returns void

    setLogger

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.ClientMetadata.html b/interfaces/_openfeature_web_sdk.ClientMetadata.html index 61c4f6204..457cf29a5 100644 --- a/interfaces/_openfeature_web_sdk.ClientMetadata.html +++ b/interfaces/_openfeature_web_sdk.ClientMetadata.html @@ -1,4 +1,4 @@ -ClientMetadata | Documentation

    Interface ClientMetadata

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

    Hierarchy

    Properties

    name? +ClientMetadata | Documentation

    Interface ClientMetadata

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

    Hierarchy

    Properties

    name? providerMetadata version? -

    Properties

    Optional Readonly name

    name?: string

    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 name

    name?: string

    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 732b785ca..e0c514f44 100644 --- a/interfaces/_openfeature_web_sdk.CommonProvider.html +++ b/interfaces/_openfeature_web_sdk.CommonProvider.html @@ -1,4 +1,4 @@ -CommonProvider | Documentation

    Interface CommonProvider

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

    Hierarchy

    Properties

    events? +CommonProvider | Documentation

    Interface CommonProvider

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

    Hierarchy

    Properties

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

    Properties

    Optional events

    events?: GenericEventEmitter<Record<string, unknown>>

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    -

    Optional Readonly status

    status?: ProviderStatus

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

    Optional Readonly status

    status?: ProviderStatus

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

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

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

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

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    • onClose(): Promise<void>

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

      -

      Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<void>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html b/interfaces/_openfeature_web_sdk.EvaluationLifeCycle.html index 1845e65a6..324a81549 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 {
        addHooks(...hooks): T;
        clearHooks(): T;
        getHooks(): BaseHook<FlagValue, unknown, unknown>[];
    }

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    addHooks +EvaluationLifeCycle | Documentation

    Interface EvaluationLifeCycle<T>

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

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    addHooks clearHooks getHooks

    Methods

    addHooks

    • addHooks(...hooks): T

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

      Parameters

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

        A list of hooks that should always run

      Returns T

      The receiver (this object)

      -

    clearHooks

    clearHooks

    getHooks

    getHooks

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface Eventing

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

    Hierarchy

    Implemented by

    Methods

    addHandler +Eventing | Documentation

    Interface Eventing

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

    Hierarchy

    Implemented by

    Methods

    addHandler getHandlers removeHandler

    Methods

    addHandler

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

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

      Type Parameters

      Parameters

      • eventType: T

        The provider event type to listen to

      • handler: EventHandler<T>

        The handler to run on occurrence of the event type

        -

      Returns void

    getHandlers

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

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

      +

    Returns void

    getHandlers

    removeHandler

    removeHandler

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

    • Removes a handler for the given provider event type.

      Type Parameters

      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 +

    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 032b82e4a..b0da804b3 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

    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

    Methods

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

    The value returned if an error occurs

  • Optional options: FlagEvaluationOptions

    Additional flag evaluation options

    • Returns EvaluationDetails<boolean>

    Flag evaluation details response

    -

    getBooleanValue

    getBooleanValue

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

    • Performs a flag evaluation that returns a boolean.

      Parameters

      • flagKey: string

        The flag key uniquely identifies a particular flag

      • defaultValue: boolean

        The value returned if an error occurs

      • Optional options: FlagEvaluationOptions

        Additional flag evaluation options

      Returns boolean

      Flag evaluation response

      -

    getNumberDetails

    getNumberDetails

    getNumberValue

    getNumberValue

    getObjectDetails

    getObjectDetails

    getObjectValue

    getObjectValue

    getStringDetails

    getStringDetails

    getStringValue

    getStringValue

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

  • Type Parameters

    • T extends string = string

    Parameters

    Returns T

    • Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html b/interfaces/_openfeature_web_sdk.FlagEvaluationOptions.html index 51936ebd9..99e203a7f 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 a61878431..b1db11b05 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 {
        clientMetadata: ClientMetadata;
        context: Readonly<EvaluationContext>;
        defaultValue: T;
        flagKey: string;
        flagValueType: FlagValueType;
        logger: Logger;
        providerMetadata: ProviderMetadata;
    }

    Type Parameters

    Hierarchy

    Properties

    clientMetadata +HookContext | Documentation

    Interface HookContext<T>

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

    Type Parameters

    Hierarchy

    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 b81070d18..12232789e 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 60bce91b2..486d4a33c 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 {
        getContext(): EvaluationContext;
        setContext(context): T;
    }

    Type Parameters

    • T

    Implemented by

    Methods

    getContext +ManageContext | Documentation

    Interface ManageContext<T>

    interface ManageContext {
        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 3092e7b50..41483850b 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 {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    setLogger +ManageLogger | Documentation

    Interface ManageLogger<T>

    interface ManageLogger {
        setLogger(logger): T;
    }

    Type Parameters

    • T

    Hierarchy

    Implemented by

    Methods

    setLogger

    Methods

    setLogger

    • setLogger(logger): T

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

      Parameters

      • logger: Logger

        The logger to be used

      Returns T

      The receiver (this object)

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/_openfeature_web_sdk.Metadata.html b/interfaces/_openfeature_web_sdk.Metadata.html index 1882fcbe3..435f022d3 100644 --- a/interfaces/_openfeature_web_sdk.Metadata.html +++ b/interfaces/_openfeature_web_sdk.Metadata.html @@ -1 +1 @@ -Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Metadata | Documentation

    Interface Metadata

    interface Metadata {}

    Hierarchy

    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 082b54d38..bf8173b30 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?: GenericEventEmitter<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

    Implemented by

    Properties

    events? +
    interface Provider {
        events?: GenericEventEmitter<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

    Implemented by

    Properties

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

    Properties

    Optional events

    events?: GenericEventEmitter<Record<string, unknown>>

    An event emitter for ProviderEvents.

    See

    ProviderEvents

    -

    Optional Readonly hooks

    hooks?: Hook[]

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

    Optional Readonly hooks

    hooks?: Hook[]

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

    -

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    Readonly metadata

    metadata: ProviderMetadata

    Optional Readonly runsOn

    runsOn?: Paradigm

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

    -

    Optional Readonly status

    status?: ProviderStatus

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

    Optional Readonly status

    status?: ProviderStatus

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

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

    -

    Methods

    Optional initialize

    Methods

    Optional initialize

    • initialize(context?): Promise<void>

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

      -

      Parameters

      Returns Promise<void>

    Optional onClose

    Optional onClose

    Optional onContextChange

    Optional onContextChange

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns Promise<void>

    resolveBooleanEvaluation

    resolveNumberEvaluation

    resolveObjectEvaluation

    resolveStringEvaluation

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ProviderMetadata

    Static data about the provider.

    -
    interface ProviderMetadata {
        name: string;
    }

    Hierarchy

    Properties

    name -

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Hierarchy

    Properties

    name +

    Properties

    Readonly name

    name: string

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/modules/_openfeature_core.html b/modules/_openfeature_core.html index 88c8afef6..f4604d1f2 100644 --- a/modules/_openfeature_core.html +++ b/modules/_openfeature_core.html @@ -74,4 +74,4 @@

    Shared js components (server and web)

    objectOrUndefined statusMatchesEvent stringOrUndefined -

    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/modules/_openfeature_server_sdk.html b/modules/_openfeature_server_sdk.html index 0d0cadc4f..86965b230 100644 --- a/modules/_openfeature_server_sdk.html +++ b/modules/_openfeature_server_sdk.html @@ -1,4 +1,4 @@ -@openfeature/server-sdk - v1.7.5 | Documentation

    Module @openfeature/server-sdk - v1.7.5

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

    Module @openfeature/server-sdk - v1.8.0

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

    OpenFeature Node.js SDK

    Specification - - Release + + Release
    @@ -233,4 +233,4 @@

    OpenFeature Node.js SDK

    objectOrUndefined statusMatchesEvent stringOrUndefined -

    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/modules/_openfeature_web_sdk.html b/modules/_openfeature_web_sdk.html index 71b920c8f..a05fd18ef 100644 --- a/modules/_openfeature_web_sdk.html +++ b/modules/_openfeature_web_sdk.html @@ -239,4 +239,4 @@

    OpenFeature Web SDK

    objectOrUndefined statusMatchesEvent stringOrUndefined -

    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/types/_openfeature_core.CommonEventDetails.html b/types/_openfeature_core.CommonEventDetails.html index 0ed6fe004..1191afeda 100644 --- a/types/_openfeature_core.CommonEventDetails.html +++ b/types/_openfeature_core.CommonEventDetails.html @@ -1 +1 @@ -CommonEventDetails | Documentation

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: string
    • providerName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CommonEventDetails | Documentation

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: 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 23b8667d3..b4c282fe4 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 e8930ab6f..adf273e5c 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 292983600..4cd67bb78 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 8b0c5253d..a8ca4e2ee 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 dd4ce53ac..8b4e7a41a 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 6ee4c096d..30c07a72c 100644 --- a/types/_openfeature_core.EventContext.html +++ b/types/_openfeature_core.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<T, U>

    EventContext<T, U>: EventMap[T] & U

    Type Parameters

    • T extends ProviderEvents

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<T, U>

    EventContext<T, U>: EventMap[T] & U

    Type Parameters

    • T extends ProviderEvents

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EventDetails<T>

    EventDetails<T>: EventContext<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<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 408a16bbe..5b0809c45 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 a08861515..87de013a9 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 2ecdcb65e..b2f2fe5e4 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 bcbdd21a4..73b7feb14 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 b63a77ecb..0eec7ba70 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 9965076bc..b961c22a4 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 9256bd8bb..9c3b369f8 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 11dca081d..7f9821b37 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 8fb442cf0..9e8f281f3 100644 --- a/types/_openfeature_core.JsonValue.html +++ b/types/_openfeature_core.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.Paradigm.html b/types/_openfeature_core.Paradigm.html index bc96c699b..72c5fb04c 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 2aa83a4d4..a58a297b1 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 1eeac4012..cb8410044 100644 --- a/types/_openfeature_core.ReadyEvent.html +++ b/types/_openfeature_core.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_core.ResolutionDetails.html b/types/_openfeature_core.ResolutionDetails.html index e78007a95..28344741b 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 c1307337b..09fdbcab4 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 61c5d07f8..98210c70f 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.CommonEventDetails.html b/types/_openfeature_server_sdk.CommonEventDetails.html index f01dc214a..43da402ff 100644 --- a/types/_openfeature_server_sdk.CommonEventDetails.html +++ b/types/_openfeature_server_sdk.CommonEventDetails.html @@ -1 +1 @@ -CommonEventDetails | Documentation

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: string
    • providerName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CommonEventDetails | Documentation

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: 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 dd38be4de..0188c4a70 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 d4f6ff9a3..250977e29 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 7750cd79b..a2e54b4e5 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 ce31aaefa..1f7ce84cc 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 5d9227d20..063c58755 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 14fb8cdbb..6fb1f6a03 100644 --- a/types/_openfeature_server_sdk.EventContext.html +++ b/types/_openfeature_server_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<T, U>

    EventContext<T, U>: EventMap[T] & U

    Type Parameters

    • T extends ProviderEvents

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<T, U>

    EventContext<T, U>: EventMap[T] & U

    Type Parameters

    • T extends ProviderEvents

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.EventDetails.html b/types/_openfeature_server_sdk.EventDetails.html index 45332e4db..c25a324f9 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<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<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 3127dd1fb..6c256320e 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 aaaca507c..79e458114 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 550151a3b..d84661c24 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 07b0c4ba5..d2f10f427 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 df5f95ce1..56f930a80 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 7c3e90c80..7e42de973 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 c518d6d7c..c8e426e58 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 848ed191a..832f19691 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 592ffdc04..727956b43 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 55e6c5118..1fff1e1cc 100644 --- a/types/_openfeature_server_sdk.JsonValue.html +++ b/types/_openfeature_server_sdk.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.Paradigm.html b/types/_openfeature_server_sdk.Paradigm.html index cc841c67e..3fff834cb 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 0cb8a583b..13a0f7b51 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 f02ac76ed..0d177768f 100644 --- a/types/_openfeature_server_sdk.ReadyEvent.html +++ b/types/_openfeature_server_sdk.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_server_sdk.ResolutionDetails.html b/types/_openfeature_server_sdk.ResolutionDetails.html index 401afd499..d80aedea8 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 30ff34e02..6a206fc70 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 f29848b06..8fff130a5 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 52325d9e7..990d6f8fa 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.CommonEventDetails.html b/types/_openfeature_web_sdk.CommonEventDetails.html index 3fbb5c525..d67cf8b11 100644 --- a/types/_openfeature_web_sdk.CommonEventDetails.html +++ b/types/_openfeature_web_sdk.CommonEventDetails.html @@ -1 +1 @@ -CommonEventDetails | Documentation

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: string
    • providerName: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CommonEventDetails | Documentation

    Type alias CommonEventDetails

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

    Type declaration

    • Optional clientName?: 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 d8831fe0c..c431c7b3b 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 f054d95d0..daba167e2 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 82866f932..8f592bb89 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 5793c247e..be177ad51 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 930e8c28f..a0c21f135 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 3828762f2..4ba395991 100644 --- a/types/_openfeature_web_sdk.EventContext.html +++ b/types/_openfeature_web_sdk.EventContext.html @@ -1 +1 @@ -EventContext | Documentation

    Type alias EventContext<T, U>

    EventContext<T, U>: EventMap[T] & U

    Type Parameters

    • T extends ProviderEvents

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +EventContext | Documentation

    Type alias EventContext<T, U>

    EventContext<T, U>: EventMap[T] & U

    Type Parameters

    • T extends ProviderEvents

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.EventDetails.html b/types/_openfeature_web_sdk.EventDetails.html index ecff819cc..138b4ae78 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<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<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 c644b8f1e..887ec1217 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 695022fef..9e8476dd9 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 62693a8cb..0e59cf20f 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 c0890bd49..2d4eb0c17 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 b3680653c..555bb4c55 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 6e8ad1406..665bc3273 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 25e27420b..3b5832d2f 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 96cb7e855..148e79cca 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 ed24ec0a9..da6772ac0 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 c64d26cbb..033ca308e 100644 --- a/types/_openfeature_web_sdk.JsonValue.html +++ b/types/_openfeature_web_sdk.JsonValue.html @@ -1,2 +1,2 @@ JsonValue | Documentation

    Type alias JsonValue

    JsonValue: PrimitiveValue | JsonObject | JsonArray

    Represents a JSON node value.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.Paradigm.html b/types/_openfeature_web_sdk.Paradigm.html index 3d34d9b36..e3c966853 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 df82bd295..ac19e3e38 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.ReadyEvent.html b/types/_openfeature_web_sdk.ReadyEvent.html index f4a70269d..e92eb83b2 100644 --- a/types/_openfeature_web_sdk.ReadyEvent.html +++ b/types/_openfeature_web_sdk.ReadyEvent.html @@ -1 +1 @@ -ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ReadyEvent | Documentation

    Type alias ReadyEvent

    ReadyEvent: CommonEventProps

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/_openfeature_web_sdk.ResolutionDetails.html b/types/_openfeature_web_sdk.ResolutionDetails.html index 457d10def..4a31f615b 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 32c8bc94a..7572ee23a 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 dc271200f..42781181f 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 dc6915a9f..d97bc107c 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 a958bb63f..ff6e6bea8 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 f1360b11b..a0230c560 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 8d78afddd..36d1d8b62 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 403506d96..177b31971 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 893556501..8531dd931 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 d339eb884..179ca7c7d 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 db4ce225d..40d0c6f96 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 788740af1..7b53fc928 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 567939b6d..a624c1495 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 2db45f1c0..fbf544a05 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