@harnessio/ff-nodejs-server-sdk

中文文档
1.8.13发布于 2026/10/07Apache-2.0TypeScriptESM + CJS近 30 天下载 8.9万

节点JS 环境的特性旗 SDK

中文使用文档
文档目录6 节
  1. 所需资源
  2. 安装 SDK
  3. 代码样本
  4. 运行示例
  5. 使用自定义 TLS 证书
  6. 其他阅读

节点.js SDK 用于调理特性旗

TypeScript version Node.js version APLv2

使用此 README 开始为 Node. 这份指南概述了获得 从SDK开始,并提供一个完整的代码样本供您试用.

此样本不包括配置选项, 用于深度步骤和配置 SDK, 例如功能失效 流出或使用我们的中继代理服务器,参见 节点.js SDK 参考。 。 。 .

所需资源

要使用 SDK , 请确定您是否:

  • 安装了 Node.js v12 或更新版本

与我们的测试代码样本一样

安装 SDK

第一步是安装FF SDK作为应用程序中的依赖. 要使用 npm 安装,请使用 :

npm install @harnessio/ff-nodejs-server-sdk

或者用纱线安装,使用:

yarn add @harnessio/ff-nodejs-server-sdk

代码样本

下面是一个完整的代码示例,可以用来测试 harnessappdemodarkmode 您创建的旗帜 驾驭平台. 当你运行代码时,它会:

  • 接通FF服务.
  • 每10秒报告一旗的值,直到连接关闭.
  • 听着,当 harnessappdemodarkmode 旗子在Harness平台上切换或关闭,并报告新值.
const { Client, Event } = require('@harnessio/ff-nodejs-server-sdk');

(async () => {
  // set apiKey to your SDK API Key
  const apiKey = 'YOUR_FF_SDK_KEY';

  // set flagName to your flag identifier from the UI
  const flagName = 'harnessappdemodarkmode';

  console.log('Harness SDK Getting Started');

  // Create Client
  const client = new Client(apiKey);

  // Create a target (different targets can receive different results based on rules.
  // Here we are including "location" as a custom attribute)
  const target = {
    identifier: 'nodeserversdk',
    name: 'NodeServerSDK',
    attributes: {
      location: 'emea',
    },
  };

  try {
    await client.waitForInitialization();
  } catch (e) {
    console.log("Error when authenticating Feature Flags client: " + e)
  }

  try {
    // Log the state of the flag every 10 seconds
    setInterval(async () => {
      const value = await client.boolVariation(flagName, target, false);
      console.log('Flag variation:', value);
    }, 10000);

    // We can also watch for the event when a flag changes
    client.on(Event.CHANGED, async (flagIdentifier) => {
      const value = await client.boolVariation(flagIdentifier, target, false);
      console.log(`${flagIdentifier} changed: ${value}`);
    });
  } catch (e) {
    console.error('Error:', e);
  }
})();

运行示例

要运行示例, 请执行您的脚本 :

node example.js

完成后,您可以通过使用 控制- 说吧c. 国家。 。 。 .

使用自定义 TLS 证书

如果使用不使用被广泛公开的预捆绑 CA 的代理或 SMP 实例, 您可以使用 tlsTrustedCa 选项. 此选项会选择一个路径到一个包含一组包含 PEM 格式证书的文件 。 如果存在此选项, HTTP 客户端将忽略 任何预捆绑的证书,所以您需要包含自定义证书的全部证书链.

  const client = new Client(apiKey, {
    baseUrl: 'https://ffserver:8000/api/1.0',
    eventsUrl: 'https://ffserver:8001/api/1.0',
    tlsTrustedCa: 'path_to_cert_chain.crt',
  });

其他阅读

更多示例和配置选项,见 节点.js SDK 参考 编辑 测试节点.js项目。 。 。 . 关于"地物"旗的更多信息,参见我们 特性标记文档。 。 。 .

版本与发布记录

@harnessio/ff-nodejs-server-sdk 共发布 63 个版本,首次发布于 2021/10/15;过去 12 个月发布了 3 个版本。

版本发布日期距今
1.8.13latest2026/10/071 个月前
1.8.122026/01/1210 个月前
1.8.112025/11/2611 个月前
1.8.102025/11/101 年前
1.8.92025/08/181.2 年前
1.8.82025/07/231.3 年前

其他发布通道:beta → 1.6.0-rc.2。

关于 @harnessio/ff-nodejs-server-sdk 的常见问题

@harnessio/ff-nodejs-server-sdk 是什么?

节点JS 环境的特性旗 SDK

如何安装 @harnessio/ff-nodejs-server-sdk?

在项目目录运行 npm install @harnessio/ff-nodejs-server-sdk,或使用 pnpm add / yarn add / bun add。

@harnessio/ff-nodejs-server-sdk 支持 TypeScript 吗?

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

@harnessio/ff-nodejs-server-sdk 支持 ESM 还是 CommonJS?

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

@harnessio/ff-nodejs-server-sdk 需要什么版本的 Node.js?

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

@harnessio/ff-nodejs-server-sdk 可以商用吗?

@harnessio/ff-nodejs-server-sdk 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@harnessio/ff-nodejs-server-sdk 的下载量有多少?

根据 npm 官方下载统计,@harnessio/ff-nodejs-server-sdk 在 2026/10/18 – 2026/11/16 这 30 天内被下载 89,267 次,日均约 2,976 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@harnessio/ff-nodejs-server-sdk 还在维护吗?

最新版本 1.8.13 发布于 2026/10/07(1 个月前);至今共发布 63 个版本,其中过去 12 个月发布了 3 个;首次发布于 2021/10/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。