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.

Hierarchy

Provider

Index

Properties

hooks? metadata

Methods

resolveBooleanEvaluation resolveNumberEvaluation resolveObjectEvaluation resolveStringEvaluation

Properties

`Optional` `Readonly` hooks

hooks?: Hook<FlagValue>[]

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

Get metadata about registered provider.

Returns

Provider Metadata

Methods

resolveBooleanEvaluation

resolveBooleanEvaluation(flagKey: string, defaultValue: boolean, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<boolean>>
Resolve a boolean flag and its evaluation details.
Parameters
- flagKey: string
- defaultValue: boolean
- context: EvaluationContext
- logger: Logger
Returns Promise<ResolutionDetails<boolean>>
- Defined in src/types.ts:245

resolveNumberEvaluation

resolveNumberEvaluation(flagKey: string, defaultValue: number, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<number>>
Resolve a numeric flag and its evaluation details.
Parameters
- flagKey: string
- defaultValue: number
- context: EvaluationContext
- logger: Logger
Returns Promise<ResolutionDetails<number>>
- Defined in src/types.ts:265

resolveObjectEvaluation

resolveObjectEvaluation<T>(flagKey: string, defaultValue: T, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<T>>
Resolve and parse an object flag and its evaluation details.
Type Parameters
- T extends JsonValue
Parameters
- flagKey: string
- defaultValue: T
- context: EvaluationContext
- logger: Logger
Returns Promise<ResolutionDetails<T>>
- Defined in src/types.ts:275

resolveStringEvaluation

resolveStringEvaluation(flagKey: string, defaultValue: string, context: EvaluationContext, logger: Logger): Promise<ResolutionDetails<string>>
Resolve a string flag and its evaluation details.
Parameters
- flagKey: string
- defaultValue: string
- context: EvaluationContext
- logger: Logger
Returns Promise<ResolutionDetails<string>>
- Defined in src/types.ts:255

Interface Provider

Hierarchy

Index

Properties

Methods

Properties

Optional Readonly hooks

Readonly metadata

Returns

Methods

resolveBooleanEvaluation

Parameters

flagKey: string

defaultValue: boolean

context: EvaluationContext

logger: Logger

Returns Promise<ResolutionDetails<boolean>>

resolveNumberEvaluation

Parameters

flagKey: string

defaultValue: number

context: EvaluationContext

logger: Logger

Returns Promise<ResolutionDetails<number>>

resolveObjectEvaluation

Type Parameters

T extends JsonValue

Parameters

flagKey: string

defaultValue: T

context: EvaluationContext

logger: Logger

Returns Promise<ResolutionDetails<T>>

resolveStringEvaluation

Parameters

flagKey: string

defaultValue: string

context: EvaluationContext

logger: Logger

Returns Promise<ResolutionDetails<string>>

Settings

Member Visibility

Theme

`Optional` `Readonly` hooks

`Readonly` metadata