# @flipt-io/flipt 中文文档

规范地址：https://npmcn.com/package/%40flipt-io/flipt/

版本：1\.5\.1
npm 元数据更新时间：2026-11-07T15:52:46.081Z
中文译文更新时间：2026-11-14T23:21:57.129Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40flipt-io/flipt
原文对照：https://npmcn.com/package/%40flipt-io/flipt/?lang=original

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

- 包体积（解压后）：54.6 kB，32 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2022-11-21T16:31:31.293Z
- 最新版本发布：2026-11-07T15:52:45.861Z
- 近 30 天下载量：473906（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 2 个）

## 中文简介

翻转服务器 SDK

## 安装

```sh
npm install @flipt-io/flipt
```

也可以使用：`pnpm add @flipt-io/flipt`、`yarn add @flipt-io/flipt`、`bun add @flipt-io/flipt`

## README

# 翻转节点

[![npm](https://img.shields.io/npm/v/@flipt-io/flipt?label=%40flipt-io%2Fflipt)](https://www.npmjs.com/package/@flipt-io/flipt)

此目录包含 Flipt 的 TypeScript 源代码 [服务器侧](https://www.flipt.io/docs/integration/server/rest) 客户端.

## 文档

API 文档可见于 [https://www.flipt.io/docs/参考资料/概览](https://www.flipt.io/docs/reference/overview)。 。 。 .

## 安装

```sh
npm i @flipt-io/flipt@{version}
```

## 使用量

在您的节点代码中, 您可以导入此客户端并以此方式使用 :

```typescript
import { FliptClient } from "@flipt-io/flipt";

const fliptClient = new FliptClient();

async function evaluate() {
  const variantEvaluationResponse = await fliptClient.evaluation.variant({
    namespaceKey: "default",
    flagKey: "flag1",
    entityId: "entity",
    context: { fizz: "buzz" }
  });

  console.log(variantEvaluationResponse);
}
```

报告有更详细的例子 [实例](https://npmcn.com/package/%40flipt-io/flipt/examples) 目录.

### 设置 HTTP 信头

您可以通过使用 HTTP 来设置客户端的自定义 HTTP 页眉 `headers` 参数.

```typescript
const fliptClient = new FliptClient({
  headers: { "X-Custom-Header": "Custom-Value" }
});
```

### 翻转 V2 环境支持

Flipt V2引入了 [环境](https://docs.flipt.io/v2/concepts#environments)。该客户端通过使用 `X-Flipt-Environment` 头曰.

```typescript
const fliptClient = new FliptClient({
  headers: { "X-Flipt-Environment": "production" }
});
```

### 计量

有人支持 [数据犬 RUM](https://docs.datadoghq.com/real_user_monitoring/) 通过这个客户端。 这使得您可以跟踪特性旗评价的值,以及它与活动浏览器会话的关系.

您可以首先安装这样的数据狗 RUM 客户端 :

```
npm install --save @datadog/browser-rum
```

开始追踪数据犬的特性旗:

```typescript
import { datadogRum } from "@datadog/browser-rum";
import { FliptClient, FliptMetrics } from "@flipt-io/flipt";

datadogRum.init({
  applicationId: "<APPLICATION_ID>",
  clientToken: "<CLIENT_TOKEN>",
  site: "datadoghq.com",
  service: "<SERVICE_NAME>",
  env: "<ENV_NAME>",
  enableExperimentalFeatures: ["feature_flags"],
  sessionSampleRate: 100,
  sessionReplaySampleRate: 20,
  trackUserInteractions: true,
  trackResources: true,
  trackLongTasks: true,
  defaultPrivacyLevel: "mask-user-input"
});

datadogRum.startSessionReplayRecording();

const metricsClient = new FliptMetrics(
  new FliptClient({
    url: "http://localhost:8080"
  }).evaluation,
  datadogRum
);

const response = await metricsClient.variant({
  namespaceKey: "default",
  flagKey: "hello-this",
  entityId: uuidv4(),
  context: {}
});
```

## 常见问题

### @flipt-io/flipt 是什么？

翻转服务器 SDK

### 如何安装 @flipt-io/flipt？

在项目目录运行 npm install @flipt-io/flipt，或使用 pnpm add / yarn add / bun add。

### @flipt-io/flipt 支持 TypeScript 吗？

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

### @flipt-io/flipt 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @flipt-io/flipt 可以商用吗？

@flipt-io/flipt 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @flipt-io/flipt 的下载量有多少？

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

### @flipt-io/flipt 还在维护吗？

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