Types

The Flagship binding uses the following TypeScript types. These are available from the @cloudflare/workers-types package after running npx wrangler types.

The binding type. Each Flagship binding in your Wrangler configuration is typed as Flagship on the Env interface.

interface Env {
	FLAGS: Flagship;
}

Refer to the methods reference for the full list of evaluation methods available on the binding.

A record of attribute names to values passed for targeting rules. Use this to provide user attributes such as user ID, country, or plan type.

type FlagshipEvaluationContext = Record<string, string | number | boolean>;

Returned by the *Details methods. Contains the evaluated value and metadata about how Flagship resolved the flag.

interface FlagshipEvaluationDetails<T> {
	flagKey: string;
	value: T;
	variant?: string;
	reason?: string;
	errorCode?: string;
}

Refer to evaluation reasons and error codes for the full list of possible values.