← Cloudflare Flagship / flagship / binding

Типы

Привязка Flagship использует следующие типы TypeScript. Они доступны из @cloudflare/workers-types пакет после запуска npx wrangler types.

`Flagship`

Тип привязки. Каждая привязка Flagship в конфигурации Wrangler имеет тип Flagship на Env интерфейс.

interface Env {
	FLAGS: Flagship;
}

См. справочник по методам для полного списка методов оценки, доступных в привязке.

`FlagshipEvaluationContext`

Запись сопоставлений имён атрибутов со значениями, переданная для правила таргетинга. Используйте это для передачи атрибутов пользователя, таких как идентификатор пользователя, страна или тип тарифного плана.

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

`FlagshipEvaluationDetails`

Возвращается *Details методы. Содержит вычисленное значение и метаданные о том, как Flagship разрешил флаг.

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

Свойство	Тип	Описание
`flagKey`	`string`	Ключ оценённого флага.
`value`	`T`	Итоговое значение флага.
`variant`	`string`	Имя подошедшего варианта, если он есть.
`reason`	`string`	Почему флаг получил именно такое значение (например, `"TARGETING_MATCH"` или `"DEFAULT"`).
`errorCode`	`string`	Код ошибки, если оценка завершилась неудачей (например, `"TYPE_MISMATCH"` или `"GENERAL"`).

См. причины оценки и коды ошибок для полного списка возможных значений.