Interface Client

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

Hierarchy (view full)

Index

Properties

metadata providerStatus

Methods

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

Properties

`Readonly` metadata

metadata: ClientMetadata

`Readonly` providerStatus

providerStatus: ProviderStatus

Returns the status of the associated provider.

Methods

addHandler

addHandler(eventType, handler): void
Adds a handler for the given provider event type. The handlers are called in the order they have been added.
Parameters
- eventType: ConfigurationChanged
  The provider event type to listen to
- handler: EventHandler<ConfigurationChanged>
  The handler to run on occurrence of the event type
Returns void
Inherited from Eventing.addHandler
- Defined in packages/shared/src/events/eventing.ts:76
addHandler(eventType, handler): void
Parameters
- eventType: ServerNotChangeEvents
- handler: EventHandler<ServerNotChangeEvents>
Returns void
Inherited from Eventing.addHandler
- Defined in packages/shared/src/events/eventing.ts:86
addHandler(eventType, handler): void
Parameters
- eventType: ProviderEvents
- handler: EventHandler<ProviderEvents>
Returns void
Inherited from Eventing.addHandler
- Defined in packages/shared/src/events/eventing.ts:90

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)
Inherited from EvaluationLifeCycle.addHooks
- Defined in packages/shared/src/hooks/evaluation-lifecycle.ts:14

clearHooks

clearHooks(): Client
Clears all the hooks that are registered on this receiver.

Returns Client
The receiver (this object)
Inherited from EvaluationLifeCycle.clearHooks
- Defined in packages/shared/src/hooks/evaluation-lifecycle.ts:27

getBooleanDetails

getBooleanDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<boolean>>
Performs a flag evaluation that a returns an evaluation details object.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: boolean
  The value returned if an error occurs
- Optional context: EvaluationContext
  The evaluation context used on an individual flag evaluation
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns Promise<EvaluationDetails<boolean>>
Flag evaluation details response
Inherited from Features.getBooleanDetails
- Defined in packages/server/src/evaluation/evaluation.ts:33

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
Inherited from Features.getBooleanValue
- Defined in packages/server/src/evaluation/evaluation.ts:18

getContext

getContext(): EvaluationContext
Access the evaluation context set on the receiver.

Returns EvaluationContext
Evaluation context
Inherited from ManageContext.getContext
- Defined in packages/shared/src/evaluation/context.ts:26

getHandlers

getHandlers(eventType): EventHandler<ProviderEvents>[]
Gets the current handlers for the given provider event type.
Parameters
- eventType: ProviderEvents
  The provider event type to get the current handlers for
Returns EventHandler<ProviderEvents>[]
The handlers currently attached to the given provider event type
Inherited from Eventing.getHandlers
- Defined in packages/shared/src/events/eventing.ts:107

getHooks

getHooks(): BaseHook<FlagValue, unknown, unknown>[]
Access all the hooks that are registered on this receiver.

Returns BaseHook<FlagValue, unknown, unknown>[]
A list of the client hooks
Inherited from EvaluationLifeCycle.getHooks
- Defined in packages/shared/src/hooks/evaluation-lifecycle.ts:20

getNumberDetails

getNumberDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<number>>
Performs a flag evaluation that a returns an evaluation details object.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: number
  The value returned if an error occurs
- Optional context: EvaluationContext
  The evaluation context used on an individual flag evaluation
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns Promise<EvaluationDetails<number>>
Flag evaluation details response
Inherited from Features.getNumberDetails
- Defined in packages/server/src/evaluation/evaluation.ts:118
getNumberDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>
Type Parameters
- T extends number = number
Parameters
- flagKey: string
- defaultValue: T
- Optional context: EvaluationContext
- Optional options: FlagEvaluationOptions
Returns Promise<EvaluationDetails<T>>
Inherited from Features.getNumberDetails
- Defined in packages/server/src/evaluation/evaluation.ts:125

getNumberValue

getNumberValue(flagKey, defaultValue, context?, options?): Promise<number>
Performs a flag evaluation that returns a number.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: number
  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<number>
Flag evaluation response
Inherited from Features.getNumberValue
- Defined in packages/server/src/evaluation/evaluation.ts:95
getNumberValue<T>(flagKey, defaultValue, context?, options?): Promise<T>
Type Parameters
- T extends number = number
Parameters
- flagKey: string
- defaultValue: T
- Optional context: EvaluationContext
- Optional options: FlagEvaluationOptions
Returns Promise<T>
Inherited from Features.getNumberValue
- Defined in packages/server/src/evaluation/evaluation.ts:102

getObjectDetails

getObjectDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<JsonValue>>
Performs a flag evaluation that a returns an evaluation details object.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: JsonValue
  The value returned if an error occurs
- Optional context: EvaluationContext
  The evaluation context used on an individual flag evaluation
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns Promise<EvaluationDetails<JsonValue>>
Flag evaluation details response
Inherited from Features.getObjectDetails
- Defined in packages/server/src/evaluation/evaluation.ts:164
getObjectDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>
Type Parameters
- T extends JsonValue = JsonValue
Parameters
- flagKey: string
- defaultValue: T
- Optional context: EvaluationContext
- Optional options: FlagEvaluationOptions
Returns Promise<EvaluationDetails<T>>
Inherited from Features.getObjectDetails
- Defined in packages/server/src/evaluation/evaluation.ts:171

getObjectValue

getObjectValue(flagKey, defaultValue, context?, options?): Promise<JsonValue>
Performs a flag evaluation that returns an object.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: JsonValue
  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<JsonValue>
Flag evaluation response
Inherited from Features.getObjectValue
- Defined in packages/server/src/evaluation/evaluation.ts:141
getObjectValue<T>(flagKey, defaultValue, context?, options?): Promise<T>
Type Parameters
- T extends JsonValue = JsonValue
Parameters
- flagKey: string
- defaultValue: T
- Optional context: EvaluationContext
- Optional options: FlagEvaluationOptions
Returns Promise<T>
Inherited from Features.getObjectValue
- Defined in packages/server/src/evaluation/evaluation.ts:148

getStringDetails

getStringDetails(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<string>>
Performs a flag evaluation that a returns an evaluation details object.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: string
  The value returned if an error occurs
- Optional context: EvaluationContext
  The evaluation context used on an individual flag evaluation
- Optional options: FlagEvaluationOptions
  Additional flag evaluation options
Returns Promise<EvaluationDetails<string>>
Flag evaluation details response
Inherited from Features.getStringDetails
- Defined in packages/server/src/evaluation/evaluation.ts:72
getStringDetails<T>(flagKey, defaultValue, context?, options?): Promise<EvaluationDetails<T>>
Type Parameters
- T extends string = string
Parameters
- flagKey: string
- defaultValue: T
- Optional context: EvaluationContext
- Optional options: FlagEvaluationOptions
Returns Promise<EvaluationDetails<T>>
Inherited from Features.getStringDetails
- Defined in packages/server/src/evaluation/evaluation.ts:79

getStringValue

getStringValue(flagKey, defaultValue, context?, options?): Promise<string>
Performs a flag evaluation that returns a string.
Parameters
- flagKey: string
  The flag key uniquely identifies a particular flag
- defaultValue: string
  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<string>
Flag evaluation response
Inherited from Features.getStringValue
- Defined in packages/server/src/evaluation/evaluation.ts:49
getStringValue<T>(flagKey, defaultValue, context?, options?): Promise<T>
Type Parameters
- T extends string = string
Parameters
- flagKey: string
- defaultValue: T
- Optional context: EvaluationContext
- Optional options: FlagEvaluationOptions
Returns Promise<T>
Inherited from Features.getStringValue
- Defined in packages/server/src/evaluation/evaluation.ts:56

removeHandler

removeHandler(eventType, handler): void
Removes a handler for the given provider event type.
Parameters
- eventType: ProviderEvents
  The provider event type to remove the listener for
- handler: EventHandler<ProviderEvents>
  The handler to remove for the provider event type
Returns void
Inherited from Eventing.removeHandler
- Defined in packages/shared/src/events/eventing.ts:100

setContext

setContext(context): Client
Sets evaluation context that will be used during flag evaluations on this receiver.
Parameters
- context: EvaluationContext
  Evaluation context
Returns Client
The receiver (this object)
Inherited from ManageContext.setContext
- Defined in packages/shared/src/evaluation/context.ts:35

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)
Inherited from ManageLogger.setLogger
- Defined in packages/shared/src/logger/logger.ts:21

Interface Client

Hierarchy (view full)

Index

Properties

Methods

Properties

Readonly metadata

Readonly providerStatus

Methods

addHandler

Parameters

Returns void

Parameters

Returns void

Parameters

Returns void

addHooks

Parameters

Returns Client

clearHooks

Returns Client

getBooleanDetails

Parameters

Returns Promise<EvaluationDetails<boolean>>

getBooleanValue

Parameters

Returns Promise<boolean>

getContext

Returns EvaluationContext

getHandlers

Parameters

Returns EventHandler<ProviderEvents>[]

getHooks

Returns BaseHook<FlagValue, unknown, unknown>[]

getNumberDetails

Parameters

Returns Promise<EvaluationDetails<number>>

Type Parameters

Parameters

Returns Promise<EvaluationDetails<T>>

getNumberValue

Parameters

Returns Promise<number>

Type Parameters

Parameters

Returns Promise<T>

getObjectDetails

Parameters

Returns Promise<EvaluationDetails<JsonValue>>

Type Parameters

Parameters

Returns Promise<EvaluationDetails<T>>

getObjectValue

Parameters

Returns Promise<JsonValue>

Type Parameters

Parameters

Returns Promise<T>

getStringDetails

Parameters

Returns Promise<EvaluationDetails<string>>

Type Parameters

Parameters

Returns Promise<EvaluationDetails<T>>

getStringValue

Parameters

Returns Promise<string>

Type Parameters

Parameters

Returns Promise<T>

removeHandler

Parameters

Returns void

setContext

Parameters

Returns Client

setLogger

Parameters

Returns Client

Settings

`Readonly` metadata

`Readonly` providerStatus