Interface Features

interface Features {
    getBooleanDetails(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<boolean>>;
    getBooleanValue(flagKey: string, defaultValue: boolean, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<boolean>;
    getNumberDetails(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<number>>;
    getNumberDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
    getNumberValue(flagKey: string, defaultValue: number, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<number>;
    getNumberValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
    getObjectDetails(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<JsonValue>>;
    getObjectDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
    getObjectValue(flagKey: string, defaultValue: JsonValue, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<JsonValue>;
    getObjectValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
    getStringDetails(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<string>>;
    getStringDetails<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<EvaluationDetails<T>>;
    getStringValue(flagKey: string, defaultValue: string, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<string>;
    getStringValue<T>(flagKey: string, defaultValue: T, context?: EvaluationContext, options?: FlagEvaluationOptions): Promise<T>;
}

Hierarchy (view full)

Methods

getBooleanDetails getBooleanValue getNumberDetails getNumberValue getObjectDetails getObjectValue getStringDetails getStringValue

Methods

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

    • Optionalcontext: EvaluationContext

      The evaluation context used on an individual flag evaluation

    • Optionaloptions: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<EvaluationDetails<boolean>>

    Flag evaluation details response

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

    • Optionalcontext: EvaluationContext

      The evaluation context used on an individual flag evaluation

    • Optionaloptions: FlagEvaluationOptions

      Additional flag evaluation options

    Returns Promise<boolean>

    Flag evaluation response

getNumberDetails

getNumberValue

getObjectDetails

getObjectValue

getStringDetails

getStringValue

Settings

Member Visibility

On This Page

Methods