Interface Client

Hierarchy

EvaluationLifeCycle<Client>
Features
ManageContext<Client>
ManageLogger<Client>
- Client

Index

Properties

Methods

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

Properties

`Readonly` metadata

metadata: ClientMetadata

Methods

addHooks

addHooks(...hooks: Hook<FlagValue>[]): 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.

Returns
The receiver (this object)
Parameters
- Rest ...hooks: Hook<FlagValue>[]
  
  A list of hooks that should always run
Returns Client
Inherited from EvaluationLifeCycle.addHooks
- Defined in src/types.ts:412

clearHooks

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

Returns
The receiver (this object)

Returns Client
Inherited from EvaluationLifeCycle.clearHooks
- Defined in src/types.ts:427

getBooleanDetails

getBooleanDetails(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<boolean>>
Performs a flag evaluation that a returns an evaluation details object.

Returns
Flag evaluation details response
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>>
Inherited from Features.getBooleanDetails
- Defined in src/types.ts:75

getBooleanValue

getBooleanValue(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<boolean>
Performs a flag evaluation that returns a boolean.

Returns
Flag evaluation response
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>
Inherited from Features.getBooleanValue
- Defined in src/types.ts:59

getContext

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

Returns
Evaluation context

Returns EvaluationContext
Inherited from ManageContext.getContext
- Defined in src/types.ts:436

getHooks

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

Returns
A list of the client hooks

Returns Hook<FlagValue>[]
Inherited from EvaluationLifeCycle.getHooks
- Defined in src/types.ts:419

getNumberDetails

getNumberDetails(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<number>>
Performs a flag evaluation that a returns an evaluation details object.

Returns
Flag evaluation details response
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>>
Inherited from Features.getNumberDetails
- Defined in src/types.ts:161
getNumberDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): 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 src/types.ts:167

getNumberValue

getNumberValue(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<number>
Performs a flag evaluation that returns a number.

Returns
Flag evaluation response
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>
Inherited from Features.getNumberValue
- Defined in src/types.ts:138
getNumberValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): 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 src/types.ts:144

getObjectDetails

getObjectDetails(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<JsonValue>>
Performs a flag evaluation that a returns an evaluation details object.

Returns
Flag evaluation details response
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>>
Inherited from Features.getObjectDetails
- Defined in src/types.ts:207
getObjectDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): 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 src/types.ts:213

getObjectValue

getObjectValue(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<JsonValue>
Performs a flag evaluation that returns an object.

Returns
Flag evaluation response
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>
Inherited from Features.getObjectValue
- Defined in src/types.ts:184
getObjectValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): 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 src/types.ts:190

getStringDetails

getStringDetails(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<string>>
Performs a flag evaluation that a returns an evaluation details object.

Returns
Flag evaluation details response
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>>
Inherited from Features.getStringDetails
- Defined in src/types.ts:115
getStringDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): 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 src/types.ts:121

getStringValue

getStringValue(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<string>
Performs a flag evaluation that returns a string.

Returns
Flag evaluation response
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>
Inherited from Features.getStringValue
- Defined in src/types.ts:92
getStringValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): 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 src/types.ts:98

setContext

setContext(context: EvaluationContext): Client
Sets evaluation context that will be used during flag evaluations on this receiver.

Returns
The receiver (this object)
Parameters
- context: EvaluationContext
  
  Evaluation context
Returns Client
Inherited from ManageContext.setContext
- Defined in src/types.ts:446

setLogger

setLogger(logger: 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.

Returns
The receiver (this object)
Parameters
- logger: Logger
  
  The logger to be used
Returns Client
Inherited from ManageLogger.setLogger
- Defined in src/types.ts:460

Interface Client

Hierarchy

Index

Properties

Methods

Properties

Readonly metadata

Methods

addHooks

Returns

Parameters

Rest ...hooks: Hook<FlagValue>[]

Returns Client

clearHooks

Returns

Returns Client

getBooleanDetails

Returns

Parameters

flagKey: string

defaultValue: boolean

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<EvaluationDetails<boolean>>

getBooleanValue

Returns

Parameters

flagKey: string

defaultValue: boolean

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<boolean>

getContext

Returns

Returns EvaluationContext

getHooks

Returns

Returns Hook<FlagValue>[]

getNumberDetails

Returns

Parameters

flagKey: string

defaultValue: number

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<EvaluationDetails<number>>

Type Parameters

T extends number = number

Parameters

flagKey: string

defaultValue: T

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<EvaluationDetails<T>>

getNumberValue

Returns

Parameters

flagKey: string

defaultValue: number

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<number>

Type Parameters

T extends number = number

Parameters

flagKey: string

defaultValue: T

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<T>

getObjectDetails

Returns

Parameters

flagKey: string

defaultValue: JsonValue

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<EvaluationDetails<JsonValue>>

Type Parameters

T extends JsonValue = JsonValue

`Readonly` metadata

`Rest` ...hooks: Hook<FlagValue>[]

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions

`Optional` context: EvaluationContext

`Optional` options: FlagEvaluationOptions