Interface Features

Hierarchy

Features
- Client

Index

Methods

getBooleanDetails getBooleanValue getNumberDetails getNumberValue getObjectDetails getObjectValue getStringDetails getStringValue

Methods

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>>
- 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>
- Defined in src/types.ts:59

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>>
- 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>>
- 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>
- 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>
- 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>>
- 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>>
- 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>
- 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>
- 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>>
- 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>>
- 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>
- 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>
- Defined in src/types.ts:98

Interface Features

Hierarchy

Index

Methods

Methods

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>

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

Parameters

flagKey: string

defaultValue: T

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<EvaluationDetails<T>>

getObjectValue

Returns

Parameters

flagKey: string

defaultValue: JsonValue

Optional context: EvaluationContext

Optional options: FlagEvaluationOptions

Returns Promise<JsonValue>

Type Parameters

T extends JsonValue = JsonValue

Parameters

`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