# @bucketeer/node-server-sdk 中文文档

规范地址：https://npmcn.com/package/%40bucketeer/node-server-sdk/

版本：0\.4\.7
npm 元数据更新时间：2026-08-07T11:58:51.188Z
中文译文更新时间：2026-11-08T17:55:15.315Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40bucketeer/node-server-sdk
原文对照：https://npmcn.com/package/%40bucketeer/node-server-sdk/?lang=original
项目主页：https://github.com/bucketeer-io/node-server-sdk#readme
源码仓库：https://github.com/bucketeer-io/node-server-sdk

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

- 包体积（解压后）：1.9 MB，340 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2021-12-23T06:34:36.159Z
- 最新版本发布：2026-08-07T11:58:50.913Z
- 近 30 天下载量：45371（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 5 个）

## 中文简介

[![npm version](https://badge.fury.io/js/@bucketeer%2Fnode-server-sdk.svg)](https://badge.fury.io/js/@bucketeer%2Fnode-server-sdk)

## 安装

```sh
npm install @bucketeer/node-server-sdk
```

也可以使用：`pnpm add @bucketeer/node-server-sdk`、`yarn add @bucketeer/node-server-sdk`、`bun add @bucketeer/node-server-sdk`

## README

[![npm version](https://badge.fury.io/js/@bucketeer%2Fnode-server-sdk.svg)](https://badge.fury.io/js/@bucketeer%2Fnode-server-sdk)

# Bucketeer 服务器- Side SDK 用于节点.js

[巴克特尔](https://bucketeer.io/) 是一个开源平台,由 [网络代理商](https://www.cyberagent.co.jp/en) 帮助各小组作出更好的决定,减少部署准备时间,并通过特征旗帜释放风险。 Bucketeer提供先进的功能,如暗发射和相继推出,根据用户属性,设备,以及其他部分进行有限的发布.

[开始](https://docs.bucketeer.io/getting-started) 使用巴克特SDK.

## 安装

看我们的 [文档](https://docs.bucketeer.io/sdk/server-side/node-js) 安装SDK.

## 捐款

我们会为你贡献给巴克特 并帮助改善它! 任何人都可以使用和享受它!

请遵照我们的贡献指南 [这里](https://docs.bucketeer.io/contribution-guide/contributing)。 。 。 .

## 示例

在树立榜样之前,请遵循以下步骤.

-   确保您拥有 `yarn` 已安装.
-   配置 `apiEndpoint` (与 URL 方案类似) `https://`)和 `apiKey` 信息输入 [指数.ts](https://github.com/bucketeer-io/node-server-sdk/blob/master/example/src/index.ts#L15-L19)。 。 。 .
-   移动到示例目录 `cd example`。 。 。 .
-   安装依赖关系 `make init`。 。 。 .

### 构建并启动示例服务器

```bash
make start
```

如果您想要使用已出版的 SDK 而不是本地版本, 请替换其导入库的行 [示例代码](https://github.com/bucketeer-io/node-server-sdk/blob/master/example/src/index.ts#L7-L8)

## 发展

### 设置

安装先决条件工具 .

-   [数字](https://github.com/nvm-sh/nvm)
-   [雅伦](https://yarnpkg.com/en/docs/install)

#### 设置节点版本

请看 [.nvmrc (英语)](https://npmcn.com/package/%40bucketeer/node-server-sdk/.nvmrc) 用于检查节点版本的文件.

```bash
nvm use
```

#### 安装依赖关系

```bash
make init
```

### SDK 软件

#### 格式

```bash
make fmt
```

#### 林特类型检查( T)

```bash
make lint
make type-check
```

#### 构建

```bash
make build
```

#### 运行单元测试

```bash
make test
```

#### 运行 e2e 测试

使用环境变量或 a 设置 E2E 测试所需的秘密 `.env` 文件在工程根中。 需要下列变量,但 `SCHEME`,这是可选的,默认为 `https`数字 :

-   `API_ENDPOINT` (如api.example.com,无计划)
-   `SCHEME` (可选;例如https或https,默认为https)
-   `CLIENT_API_KEY` (客户SDK角色 API 密钥)
-   `SERVER_API_KEY` (服务员 SDK 角色 API 密钥,用于本地评价测试)

您可以创建 `.env` 在本地开发的工程根中存档 :

```
API_ENDPOINT=your.api.endpoint
SCHEME=https
CLIENT_API_KEY=your-client-key
SERVER_API_KEY=your-server-key
```

E2E测试配置会自动加载这些值.

然后运行 :

```bash
make e2e
```

### 发布到 npm

将版本字段添加到 [软件包.json](https://npmcn.com/package/%40bucketeer/node-server-sdk/package.json),然后运行以下命令.

```bash
export NPM_TOKEN=<YOUR_NPM_TOKEN>
make publish
```

### 写作测试

-   书写测试 `src/__tests__` 目录。 测试文件应当遵循蛇 案例命名惯例. 它与使用骆驼Case的库码不同.
-   使用 `ava` 作为测试跑者。 您可以在 [ava.config.mjs (英语)](https://npmcn.com/package/%40bucketeer/node-server-sdk/ava.config.mjs) 文档.
-   使用 `make test` 命令.
-   使用 `make test-single <path-to-test-file>` 命令.

**说明:** 使用 [GitHub 动作](https://github.com/bucketeer-io/node-server-sdk/blob/master/.github/workflows/release.yml)https://github.com/bucketeer-io/node-server-sdk/blob/master/.github/workflows/release.yml 创建出已发布的标签后发布.

## 常见问题

### 如何安装 @bucketeer/node-server-sdk？

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

### @bucketeer/node-server-sdk 支持 TypeScript 吗？

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

### @bucketeer/node-server-sdk 支持 ESM 还是 CommonJS？

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

### @bucketeer/node-server-sdk 可以商用吗？

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

### @bucketeer/node-server-sdk 的下载量有多少？

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

### @bucketeer/node-server-sdk 还在维护吗？

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