Class Flagship`Abstract`

Feature flags binding for evaluating feature flags from a Cloudflare Workers script.

Example

// Get a boolean flag value with a default
const enabled = await env.FLAGS.getBooleanValue('my-feature', false);

// Get a flag value with evaluation context for targeting
const variant = await env.FLAGS.getStringValue('experiment', 'control', {
  userId: 'user-123',
  country: 'US',
});

// Get full evaluation details including variant and reason
const details = await env.FLAGS.getBooleanDetails('my-feature', false);
console.log(details.variant, details.reason);

Index

Constructors

constructor

Methods

get getBooleanDetails getBooleanValue getDetails getNumberDetails getNumberValue getObjectDetails getObjectValue getStringDetails getStringValue getValue

Constructors

constructor

new Flagship(): Flagship

Returns Flagship

Methods

get

get(
    flagKey: string,
    defaultValue?: unknown,
    context?: FlagshipEvaluationContext,
): Promise<unknown>
Get a flag value without type checking.
Parameters
- flagKey: string
  The key of the flag to evaluate.
- OptionaldefaultValue: unknown
  Optional default value returned when evaluation fails.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<unknown>

Deprecated
Use getValue() instead.
- Defined in src/server/worker-configuration.d.ts:13475

getBooleanDetails

getBooleanDetails(
    flagKey: string,
    defaultValue: boolean,
    context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<boolean>>
Get a boolean flag value with full evaluation details.
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: boolean
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<FlagshipEvaluationDetails<boolean>>
- Defined in src/server/worker-configuration.d.ts:13524

getBooleanValue

getBooleanValue(
    flagKey: string,
    defaultValue: boolean,
    context?: FlagshipEvaluationContext,
): Promise<boolean>
Get a boolean flag value.
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: boolean
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<boolean>
- Defined in src/server/worker-configuration.d.ts:13496

getDetails

getDetails<
    T extends
        string
        | number
        | boolean
        | Record<string, unknown>
        | unknown[],
>(
    flagKey: string,
    defaultValue: T,
    context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<FlagshipWidenedValue<T>>>
Get a flag value with full evaluation details, inferring its expected type from the default value.
Type Parameters
- T extends string | number | boolean | Record<string, unknown> | unknown[]
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: T
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<FlagshipEvaluationDetails<FlagshipWidenedValue<T>>>
- Defined in src/server/worker-configuration.d.ts:13489

getNumberDetails

getNumberDetails(
    flagKey: string,
    defaultValue: number,
    context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<number>>
Get a number flag value with full evaluation details.
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: number
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<FlagshipEvaluationDetails<number>>
- Defined in src/server/worker-configuration.d.ts:13538

getNumberValue

getNumberValue(
    flagKey: string,
    defaultValue: number,
    context?: FlagshipEvaluationContext,
): Promise<number>
Get a number flag value.
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: number
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<number>
- Defined in src/server/worker-configuration.d.ts:13510

getObjectDetails

getObjectDetails<T extends object>(
    flagKey: string,
    defaultValue: T,
    context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<T>>
Get an object flag value with full evaluation details.
Type Parameters
- T extends object
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: T
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<FlagshipEvaluationDetails<T>>
- Defined in src/server/worker-configuration.d.ts:13545

getObjectValue

getObjectValue<T extends object>(
    flagKey: string,
    defaultValue: T,
    context?: FlagshipEvaluationContext,
): Promise<T>
Get an object flag value.
Type Parameters
- T extends object
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: T
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<T>
- Defined in src/server/worker-configuration.d.ts:13517

getStringDetails

getStringDetails(
    flagKey: string,
    defaultValue: string,
    context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<string>>
Get a string flag value with full evaluation details.
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: string
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<FlagshipEvaluationDetails<string>>
- Defined in src/server/worker-configuration.d.ts:13531

getStringValue

getStringValue(
    flagKey: string,
    defaultValue: string,
    context?: FlagshipEvaluationContext,
): Promise<string>
Get a string flag value.
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: string
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<string>
- Defined in src/server/worker-configuration.d.ts:13503

getValue

getValue<
    T extends
        string
        | number
        | boolean
        | Record<string, unknown>
        | unknown[],
>(
    flagKey: string,
    defaultValue: T,
    context?: FlagshipEvaluationContext,
): Promise<FlagshipWidenedValue<T>>
Get a flag value, inferring its expected type from the default value.
Type Parameters
- T extends string | number | boolean | Record<string, unknown> | unknown[]
Parameters
- flagKey: string
  The key of the flag to evaluate.
- defaultValue: T
  Default value returned when evaluation fails or the flag type does not match.
- Optionalcontext: FlagshipEvaluationContext
  Optional evaluation context for targeting rules.
Returns Promise<FlagshipWidenedValue<T>>
- Defined in src/server/worker-configuration.d.ts:13482

Class FlagshipAbstract

Example

Index

Constructors

Methods

Constructors

constructor

Returns Flagship

Methods

get

Parameters

Returns Promise<unknown>

Deprecated

getBooleanDetails

Parameters

Returns Promise<FlagshipEvaluationDetails<boolean>>

getBooleanValue

Parameters

Returns Promise<boolean>

getDetails

Type Parameters

Parameters

Returns Promise<FlagshipEvaluationDetails<FlagshipWidenedValue<T>>>

getNumberDetails

Parameters

Returns Promise<FlagshipEvaluationDetails<number>>

getNumberValue

Parameters

Returns Promise<number>

getObjectDetails

Type Parameters

Parameters

Returns Promise<FlagshipEvaluationDetails<T>>

getObjectValue

Type Parameters

Parameters

Returns Promise<T>

getStringDetails

Parameters

Returns Promise<FlagshipEvaluationDetails<string>>

getStringValue

Parameters

Returns Promise<string>

getValue

Type Parameters

Parameters

Returns Promise<FlagshipWidenedValue<T>>

Settings

On This Page

Class Flagship`Abstract`