Interface Client

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

Hierarchy (view full)

Implemented by

Properties

metadata providerStatus

Methods

addHandler addHooks clearHooks getBooleanDetails getBooleanValue getHandlers getHooks getNumberDetails getNumberValue getObjectDetails getObjectValue getStringDetails getStringValue removeHandler setLogger

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. Hooks are executed in the order they were registered. Adding additional hooks will not remove existing hooks. Hooks registered on the global API object run with all evaluations. Hooks registered on the client run with all evaluations on that client.

    Parameters

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

      A list of hooks that should always run

    Returns Client

    The receiver (this object)

clearHooks

getBooleanDetails

getBooleanValue

getHandlers

getHooks

getNumberDetails

getNumberValue

getObjectDetails

getObjectValue

getStringDetails

getStringValue

removeHandler

setLogger

  • setLogger(logger): Client

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

    Parameters

    • logger: Logger

      The logger to be used

    Returns Client

    The receiver (this object)

Settings

Member Visibility

Theme

On This Page

metadataproviderStatusaddHandleraddHooksclearHooksgetBooleanDetailsgetBooleanValuegetHandlersgetHooksgetNumberDetailsgetNumberValuegetObjectDetailsgetObjectValuegetStringDetailsgetStringValueremoveHandlersetLogger

Generated using TypeDoc