Flagship 绑定使用以下 TypeScript 类型。使用 wrangler types 生成绑定类型,或使用 @cloudflare/workers-types 包。
绑定类型。在 Env 接口上,您的 Wrangler 配置文件中的每个 Flagship 绑定都被键入为 Flagship。
interface Env {
FLAGS: Flagship;
}有关绑定上所有可用评估方法的完整列表,请参阅方法参考。
传递给定向规则的属性记录。值可以递归地包含数组和对象。
type FlagshipEvaluationContextValue =
| string
| number
| boolean
| null
| FlagshipEvaluationContextValue[]
| { [key: string]: FlagshipEvaluationContextValue };
type FlagshipEvaluationContext = Record<string, FlagshipEvaluationContextValue>;数字必须是有限值。绑定会拒绝 NaN、Infinity、不受支持的对象和循环引用。
运行时也接受有效的 JavaScript Date 值。绑定会将每个日期规范化为 ISO 8601 字符串。无效日期会产生 INVALID_CONTEXT 错误。
在 TypeScript 中将 Date 值传给绑定之前,请先将其序列化为 ISO 8601 字符串。上下文类型描述 JSON 值,不包含 Date。
由 *Details 方法返回。包含被评估的值以及关于 Flagship 如何解析该标志的元数据。
interface FlagshipEvaluationDetails<T> {
flagKey: string;
value: T;
variant?: string;
reason?: string;
errorCode?: string;
errorMessage?: string;
}| 属性 | 类型 | 描述 |
|---|---|---|
flagKey |
string |
被评估标志的键。 |
value |
T |
解析后的标志值。 |
variant |
string |
匹配到的变体名称(如果有)。 |
reason |
string |
标志解析为此值的原因(例如,"TARGETING_MATCH" 或 "DEFAULT")。 |
errorCode |
string |
如果评估失败,则提供的错误代码(例如,"TYPE_MISMATCH" 或 "GENERAL")。 |
errorMessage |
string |
评估错误的说明(如有)。 |
有关可能值的完整列表,请参阅评估原因和错误代码。