# @brigadecore/brigade-sdk 中文文档

规范地址：https://npmcn.com/package/%40brigadecore/brigade-sdk/

版本：2\.4\.1
npm 元数据更新时间：2022-05-31T17:49:33.171Z
中文译文更新时间：2026-11-08T15:13:53.291Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：210 kB，124 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2021-02-19T21:23:08.309Z
- 最新版本发布：2022-05-31T17:49:33.073Z
- 近 30 天下载量：2974（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 0 个）

## 中文简介

![build](https://badgr.brigade2.io/v1/github/checks/brigadecore/brigade-sdk-for-js/badge.svg?appID=99005) [![slack](https://img.shields.io/badge/slack-brigade-brightgreen.svg?logo=slack)](https://kubernetes.slack.com/messages/C87MF1RFD)

## 安装

```sh
npm install @brigadecore/brigade-sdk
```

也可以使用：`pnpm add @brigadecore/brigade-sdk`、`yarn add @brigadecore/brigade-sdk`、`bun add @brigadecore/brigade-sdk`

## README

# 用于 JavaScript 的旅 SDK

![build](https://badgr.brigade2.io/v1/github/checks/brigadecore/brigade-sdk-for-js/badge.svg?appID=99005) [![slack](https://img.shields.io/badge/slack-brigade-brightgreen.svg?logo=slack)](https://kubernetes.slack.com/messages/C87MF1RFD)

这是用于JavaScript和TypeScript的旅2相容的SDK.

## 支持的运行时间

已经非常小心地确保了SDK在最近版本中的工作 节点以及现代浏览器(最新版本的Firefox,Chrome,Edge, Safari等) _如果转写正确 [网络软件包](https://webpack.js.org/) 或者说 类似_。 。 。 .

## 安装

使用您最喜欢的软件包管理器安装到您的工程中 .

例如:

```shell
$ npm install --save @brigadecore/brigade-sdk
```

或者说:

```shell
$ yarn add @brigadecore/brigade-sdk
```

## 基本用途

**注意: 所有后面使用 TypeScript 的示例 .**

旅API客户端如下:

```typescript
import { APIClient } from "@brigadecore/brigade-sdk"

// ...

const client = new APIClient(apiAddress, apiToken, opts)
```

在上述例子中,假定:

-   `apiAddress` 指向一旅2 API服务器. 地址必须包括: 协议(即必须使用 `http://` 或者说 `https://`) (中文(简体) ).
-   `apiToken` 为:
    -   有效的 API 令牌 。 最好使用非过期服务 账户代号。 请参看旅本身关于如何获得此类物品的文件 一个标志.
    -   空字符串是可以接受的, 但只有 API 操作 _没有_ 需求 然后由客户端支持授权.
-   `opts`正如人们可能推断的那样,这是一个可选参数。 如果包括的话,必须是 对象,可能有一个单字段 `allowInsecureConnections` 包含 值 `true` 或者说 `false` 以显示是否容忍 SSL 错误 由委托人。 如果没有指定, SSL 错误将 _没有_ 被宽容。 这个 选项仅适用于该选项的值 `apiAddress` 参数使用 `https://` 作为计划.

这个 `client` 从呼叫返回到 `new APIClient(...)` 构造器是 在更专业的客户端树上.

为与旅的“核心”部分合作获得客户(项目, 事件等:

```typescript
const coreClient = client.core()
```

这个 `coreClient` 允许向更专业的客户端导航 示例:

```typescript
const projectsClient = coreClient.projects()
```

如果您的程序需要与 旅 的特定子集进行交互 API,可以并鼓励直接即时处理 需要客户端树的子集.

例如,这个例子显示 _仅限_ 事件客户端 - 可能对于像旅网关这样的方案实用的东西 仅与旅的互动涉及创建新事件:

```typescript
import { core } from "@brigadecore/brigade-sdk"

// ...

const eventsClient = new core.EventsClient(apiAddress, apiToken, opts)
```

上述论点与我们最初的例子相同.

## 进一步实例

工作节点和基于浏览器的示例可在 [实例](https://npmcn.com/package/%40brigadecore/brigade-sdk/examples) 目录.

## 捐款

旅项目通过GitHub拉取请求接受捐款. 这个 [捐款](https://npmcn.com/package/%40brigadecore/brigade-sdk/CONTRIBUTING.md) 文档概述了帮助获取 已接受捐款.

## 支持反馈( R)

我们有一个松懈的频道! [库伯内特斯/ # brigade](https://kubernetes.slack.com/messages/C87MF1RFD) 随便吧 我们乐于提供帮助。 报告 问题或请求一个特征的问题 [这里](https://github.com/brigadecore/brigade/brigade-sdk-for-js/issues)

## 行为守则

参加该旅项目受 [CNCF 行为守则](https://github.com/cncf/foundation/blob/master/code-of-conduct.md)。 。 。 .

## 常见问题

### 如何安装 @brigadecore/brigade-sdk？

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

### @brigadecore/brigade-sdk 支持 TypeScript 吗？

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

### @brigadecore/brigade-sdk 支持 ESM 还是 CommonJS？

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

### @brigadecore/brigade-sdk 可以商用吗？

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

### @brigadecore/brigade-sdk 的下载量有多少？

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

### @brigadecore/brigade-sdk 还在维护吗？

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