# @featureflip/node 中文文档

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

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

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

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

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

- 包体积（解压后）：24.9 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.19\.0
- 运行依赖：1 个
- 首次发布：2026-04-02T04:59:24.825Z
- 最新版本发布：2026-11-09T16:17:17.886Z
- 近 30 天下载量：2388（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 34 个）

## 中文简介

Featureflip 的节点.js 服务器 SDK

## 安装

```sh
npm install @featureflip/node
```

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

## README

# @ featureflip/ 节点

节点.js SDK 用于 [特性flip](https://featureflip.io/) - 评估当地地标,高度接近零; 建于顶上 `@featureflip/js` 带有 Node.js 特定默认值.

> 使用 [打开形状](https://openfeature.dev/)看到了吗 [`@featureflip/openfeature-node`](https://www.npmjs.com/package/@featureflip/openfeature-node), (中文(简体) ), openFeature Node.js SDK 的特性flip提供商.

## 安装

```bash
npm install @featureflip/node
```

## 快速启动

```ts
import { FeatureflipClient } from '@featureflip/node';

// Blocks until flags are loaded
const client = await FeatureflipClient.create({
  sdkKey: 'your-sdk-key',
});

const enabled = client.boolVariation('my-feature', { user_id: '123' }, false);

if (enabled) {
  console.log('Feature is enabled!');
}

await client.close();
```

或者,同步获得一个手柄并手动等待:

```ts
const client = FeatureflipClient.get({ sdkKey: 'your-sdk-key' });
await client.waitForInitialization();
```

> **单通由建筑.** `FeatureflipClient.get()` 是获得客户的唯一方法——在v2.0中公共建筑师被移除. 通话 `get()` 不止一次使用相同的 SDK 密钥返回手柄指向一个共享的下方客户端. 工厂被重新计算,因此关闭一个手柄只有在最后一个手柄被关闭时才会关闭共享的核心. 这使得SDK能够安全地从每个请求处理器和DI容器中调用而不会泄露SSE连接.

## 配置

```ts
const client = await FeatureflipClient.create({
  sdkKey: 'your-sdk-key',
  baseUrl: 'https://eval.featureflip.io', // Evaluation API URL (default)
  streaming: true,           // Use SSE for real-time updates (default)
  pollInterval: 30000,       // Polling interval in ms if streaming=false
  flushInterval: 30000,      // Event flush interval in ms
  flushBatchSize: 100,       // Events per batch
  initTimeout: 10000,        // Max ms to wait for initialization
  maxStreamRetries: 5,       // SSE retries before falling back to polling
});
```

## 评价

```ts
const context = { user_id: '123', email: 'user@example.com' };

// Boolean flag
const enabled = client.boolVariation('feature-key', context, false);

// String flag
const tier = client.stringVariation('pricing-tier', context, 'free');

// Number flag
const limit = client.numberVariation('rate-limit', context, 100);

// JSON flag
const config = client.jsonVariation('ui-config', context, { theme: 'light' });
```

### 详细评价

```ts
const detail = client.variationDetail('feature-key', { user_id: '123' }, false);

console.log(detail.value);   // The evaluated value
console.log(detail.reason);  // "RuleMatch", "Fallthrough", "FlagDisabled", etc.
console.log(detail.ruleId);  // Rule ID if reason is "RuleMatch"
```

## 事件跟踪

```ts
// Track custom events
client.track('checkout-completed', { user_id: '123' }, { total: 99.99 });

// Record an identify event for analytics (does not affect flag evaluation)
client.identify({ user_id: '123', email: 'user@example.com', plan: 'pro' });

// Force flush pending events
await client.flush();
```

特性flip计算每个事件名称,每个环境. 您通过的元数据会随事件一同传输,但不会被存储,事件计数也不会被浮出应用或API.

## 测试

使用 `forTesting()` 创建具有预定旗帜值的客户端 -- -- 没有网络呼叫.

```ts
const client = FeatureflipClient.forTesting({
  'my-feature': true,
  'pricing-tier': 'pro',
});

client.boolVariation('my-feature', {}, false);     // true
client.stringVariation('pricing-tier', {}, 'free'); // 'pro'
```

## 特征

-   **地方评价** - 初始化后近零纬度
-   **实时更新** - SSE 自动倒计时
-   **事件跟踪** - 自动批量和背景冲洗
-   **测试支持** - 说吧 `forTesting()` 用于确定性单位测试的工厂
-   **类型脚本** - 包括全部类型定义
-   **节点.js 优化** - 本地用途 `http` sSE 和 HTTP 模块

## 所需资源

-   节点.js 18+

## 许可证

阿帕奇 - 2.0

## 常见问题

### @featureflip/node 是什么？

Featureflip 的节点\.js 服务器 SDK

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

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

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

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

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

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

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

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

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

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