# @featureflip/edge 中文文档

规范地址：https://npmcn.com/package/%40featureflip/edge/

版本：2\.19\.1
npm 元数据更新时间：2026-11-09T16:15:28.903Z
中文译文更新时间：2026-11-14T13:02:02.106Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40featureflip/edge
原文对照：https://npmcn.com/package/%40featureflip/edge/?lang=original
项目主页：https://featureflip.io/docs/sdks/edge/
源码仓库：https://github.com/canopy-labs/featureflip-edge

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：56.5 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.19\.0
- 运行依赖：0 个
- 首次发布：2026-10-21T04:18:21.572Z
- 最新版本发布：2026-11-09T16:15:28.678Z
- 近 30 天下载量：2133（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

Cloudflare Workers SDK for Featureflip: 边缘地方旗帜评价

## 安装

```sh
npm install @featureflip/edge
```

也可以使用：`pnpm add @featureflip/edge`、`yarn add @featureflip/edge`、`bun add @featureflip/edge`

## README

# @ featureflip/ edge (英语)

Cloudflare Workers的特长(SDK). 它从您环境旗配置的缓存副本中评估您工人内部的旗帜, 因此一个找到温暖副本的请求不会让网络呼叫来评价一面旗帜.

Cloudflare工人是唯一被支持的运行时间.

## 安装

```bash
npm install @featureflip/edge
```

## 快速启动

```ts
import { createEdgeClient } from '@featureflip/edge';

type Env = { FEATUREFLIP_SERVER_KEY: string };

// Config only at module scope: Workers forbid I/O there, and the key lives in `env`.
let flags: ReturnType<typeof createEdgeClient> | undefined;

export default {
  async fetch(request: Request, env: Env, ctx: ExecutionContext) {
    flags ??= createEdgeClient({ sdkKey: env.FEATUREFLIP_SERVER_KEY });

    const snapshot = await flags.load(ctx);
    const context = { user_id: 'user-123' };

    const enabled = snapshot.boolVariation('new-checkout', context, false);
    const detail = snapshot.variationDetail('checkout-copy', context, 'control');
    const bootstrap = snapshot.bootstrapValues(context);

    return new Response(JSON.stringify({ enabled, detail, bootstrap }));
  },
};
```

打电话 `load(ctx)` 一次请求。 在它解决之后,每个变异呼叫都是同步的.

## 选项

`sdkKey` 是唯一必要的选项。 使用服务器 SDK 密钥,而不是客户端密钥.

| 选项 | 默认 | 说明 |
| --- | --- | --- |
| `sdkKey` | 无( 需要) | 服务器 SDK 密钥。 发送为 `Authorization` 从来没有记录. |
| `baseUrl` | `https://eval.featureflip.io` | 评价API来源. |
| `ttlSeconds` | `60` | 在背景中刷新副本的年龄 . |
| `maxStaleSeconds` | `86400` | 年龄过后,一份副本就不再提供. |
| `loadTimeoutMs` | `1000` | 没有缓存副本的负载要等多久才能找到来源 . |
| `store` | 工人缓存 API | 被获取的配置由隔离器共享 . |
| `wrappers` | `[]` | `name/version` 用于包装此 SDK 的库的符号 . |
| `flushBatchSize` | `100` | 发送的事件 `POST /v1/sdk/events` 请求. |
| `fetch` | 全球 `fetch` | `fetch` 执行,主要用于测试. |

## 新鲜度

旗帜更改到达边缘流量 `ttlSeconds` (默认为60秒). 这不是服务器SDKs通过串流连接而得到的近即时推力.

一个比 `ttlSeconds` 当背景刷新运行时仍然服务。 所以,在一次空闲的咒语之后,第一个请求得到了一次更古老的拷贝,因为它开始的更新还没有完成. 一个比 `maxStaleSeconds` 未送达。 如果一个配置抓取失败,SDK在再次尝试原产地之前会退后15秒,并不断提供它拥有的任何副本.

## 过 `ctx`

通过工人 `ExecutionContext` 改为 `load(ctx)`它记录背景更新和事件冲出 `waitUntil`,所以在回复发出后,两个都完成.

无 `ctx`,请等待 `flush()` 自己在回复前,当请求结束时,背景更新可能会被切断。 SDK 不运行时记录一次性警告 `ctx`。 。 。 .

## 冷的开始

没有缓存副本, `load` 等待时间 `loadTimeoutMs` 原产地。 如果来源较慢, `load` 以 `ready === false` 服务您的默认值。 抓取会持续在背景中进行, 并填充缓存, 用于下一个请求 .

## 启动浏览器 SDK

`snapshot.bootstrapValues(context)` 只返回客户端可见旗帜的值,用于 `bootstrap` 选项 `@featureflip/browser`。如果服务器不发送客户端-可视性字段,则它不返回任何信息,因此任何旗帜都不会被错误地曝光.

## 活动

将评价排队为事件并随 `waitUntil` 当你通过 `ctx`。一个请求的冲洗发送时,只有当一个批次已经满了或10秒,从上次发送后,一个忙碌的隔离就会停止发送。 之后a `429`页:1 `5xx` 或网络出错 30 秒内无任何信息发送到窗口外 `flush()` 直接发送,封住5个请求 一个电话.

交付是最好的努力。 队列活在被隔离者的记忆中,因此Cloudflare驱逐被隔离者后的事件仍然被排入队.

## 日志

信件发送到 `console.warn`。SDK自己的开始 `[featureflip-edge]`,以及共享评价核心的少数(拒绝或放弃事件,一个被忽略) `wrappers` 符号)从 `[featureflip]`。 。 。 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @featureflip/edge 是什么？

Cloudflare Workers SDK for Featureflip: 边缘地方旗帜评价

### 如何安装 @featureflip/edge？

在项目目录运行 npm install @featureflip/edge，或使用 pnpm add / yarn add / bun add。

### @featureflip/edge 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @featureflip/edge 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @featureflip/edge 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.19\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @featureflip/edge 可以商用吗？

@featureflip/edge 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @featureflip/edge 的下载量有多少？

根据 npm 官方下载统计，@featureflip/edge 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,133 次，日均约 71 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @featureflip/edge 还在维护吗？

最新版本 2\.19\.1 发布于 2026/11/10（4 天前）；至今共发布 11 个版本，其中过去 12 个月发布了 11 个；首次发布于 2026/10/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。