Interface Provider

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

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

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

Hierarchy (view full)

Implemented by

Properties

events? hooks? metadata runsOn? status?

Methods

initialize? onClose? onContextChange? resolveBooleanEvaluation resolveNumberEvaluation resolveObjectEvaluation resolveStringEvaluation

Properties

Optional events

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

An event emitter for ProviderEvents.

See

ProviderEvents

Optional Readonly hooks

hooks?: Hook[]

A provider hook exposes a mechanism for provider authors to register hooks 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, the SDK will enforce that the defined paradigm at runtime.

Optional Readonly status

status?: ProviderStatus

Deprecated

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

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

Methods

Optional initialize

  • initialize(context?): Promise<void>

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

    Parameters

    Returns Promise<void>

Optional onClose

Optional onContextChange

resolveBooleanEvaluation

resolveNumberEvaluation

resolveObjectEvaluation

resolveStringEvaluation

Settings

Member Visibility

Theme

On This Page

eventshooksmetadatarunsOnstatusinitializeonCloseonContextChangeresolveBooleanEvaluationresolveNumberEvaluationresolveObjectEvaluationresolveStringEvaluation

Generated using TypeDoc