# @forge-dashboard/sdk-node 中文文档

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

版本：25\.18\.0
npm 元数据更新时间：2026-11-14T21:01:16.934Z
中文译文更新时间：2026-11-15T07:20:32.461Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：556 kB，23 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2026-09-21T11:35:48.323Z
- 最新版本发布：2026-11-14T21:01:16.542Z
- 近 30 天下载量：25908（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：188（近 12 个月 188 个）

## 中文简介

用于伪造dashboard的REST API的节点/TypeScript客户端,由它的OpenAPI spec生成.

## 安装

```sh
npm install @forge-dashboard/sdk-node
```

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

## README

# 伪造 dashboard- sdk- 节点

[![CI](https://github.com/alrayyes/forge-dashboard-sdk-node/actions/workflows/ci.yml/badge.svg)](https://github.com/alrayyes/forge-dashboard-sdk-node/actions/workflows/ci.yml) [![npm](https://img.shields.io/npm/v/%40forge-dashboard%2Fsdk-node)](https://www.npmjs.com/package/@forge-dashboard/sdk-node) [![Codecov](https://codecov.io/gh/alrayyes/forge-dashboard-sdk-node/graph/badge.svg)](https://codecov.io/gh/alrayyes/forge-dashboard-sdk-node) [![docs](https://img.shields.io/badge/docs-typedoc-blue)](https://alrayyes.github.io/forge-dashboard-sdk-node/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://npmcn.com/package/%40forge-dashboard/sdk-node/LICENSE)

一个节点/ TypeScript 客户端 [伪造磁盘](https://github.com/alrayyes/forge-dashboard)是因为 REST API, 从其 OpenAPI 光谱中生成, 并带有 [openapi 类型标记](https://openapi-ts.dev/) 财务报告和审定财务报表 [openapi 牵引](https://openapi-ts.dev/openapi-fetch/)它能拯救你从 手卷 HTTP 请求并重试 API 本身 .

完整 API 参考 : [https://alrayyes.github.io/forge-dashboard-sdk-node/ 页面存档备份,存于互联网档案馆](https://alrayyes.github.io/forge-dashboard-sdk-node/)

最新绿色运行的测试和覆盖报告 `main`数字 : [https://apis.ryankes.eu/forge-dashboard-sdk-node/reports/ 页面存档备份,存于互联网档案馆](https://apis.ryankes.eu/forge-dashboard-sdk-node/reports/)

## 所需资源

-   节点.js 20+或 [阿宝](https://bun.sh/) 1.1+——任何有本地血统的人 `fetch`。 。 。 .
-   一个正在运行的伪造板实例.
-   个人 API 代号用于此例子(见下文"认证")—— 每一个终点,但 `/healthz` 财务报告和审定财务报表 `/api/version` 需要一个.

## 安装

```sh
bun add @forge-dashboard/sdk-node
# or: npm install @forge-dashboard/sdk-node
```

### 替代登记册: GitHub 包件

每个版本还发布到 GitHub 套件 `@alrayyes/forge-dashboard-sdk-node` 同一个代码,不同的范围, 因为 GitHub 软件包的 npm 注册需要一个范围到 背书所有者而不是 `forge-dashboard` (原始内容存档于2012-10-12). npm org. 如果你值得的话 已经认证到 GitHub (CI 在您自己的另一个重置中, 说) 和 宁愿不持有单独的 npmjs.com 证书 仅仅安装此 一个包裹.

添加一个 `.npmrc` 指出 GitHub 包中的范围:

```
@alrayyes:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
```

然后安装范围命名 :

```sh
npm install @alrayyes/forge-dashboard-sdk-node
```

## 认证

有密码(WebAuthn)和 a 的伪造dashboard认证浏览器 会话 cookie, 但是它的 spec 文档是一个真正的无头选项: a 个人 API 令牌, 从仪表板自己的设置页面生成 (单位:千美元)`POST /api/tokens`并被派到 `Authorization: Bearer <token>` 在每次请求之后。 传过来 `createForgeDashboardClient` 或设置 `FORGE_DASHBOARD_TOKEN` 输入 环境:

```ts
import { createForgeDashboardClient } from "@forge-dashboard/sdk-node";

const client = createForgeDashboardClient("https://dashboard.example.com", {
  token: process.env.FORGE_DASHBOARD_TOKEN,
});
```

任何时刻,一个符号都可以从设置中撤销;这里面什么都没有 SDK一旦消失就自动刷新.

## 使用量

`GET /api/version` 不需要任何纪念物 也是证明 客户端到达服务器。 客户端是输入的 [`openapi-fetch`](https://openapi-ts.dev/openapi-fetch/) 因此,每个 操作是 `client.GET(path, ...)` 编号 : `client.POST(path, ...)`返回时 `{ data, error, response }`数字 :

```ts
import { createForgeDashboardClient } from "@forge-dashboard/sdk-node";

const client = createForgeDashboardClient("https://dashboard.example.com");

const { data } = await client.GET("/api/version", {});
console.log("server version:", data?.version);
```

获取自己的仪表板需要一个符号,并显示输入错误 处理 :

```ts
import {
  ApiError,
  createForgeDashboardClient,
  decodeError,
} from "@forge-dashboard/sdk-node";

const client = createForgeDashboardClient("https://dashboard.example.com", {
  token: process.env.FORGE_DASHBOARD_TOKEN,
});

const { data, error, response } = await client.GET("/api/dashboard", {});
if (error) {
  const apiErr = decodeError(response, error);
  if (apiErr instanceof ApiError && apiErr.statusCode === 401) {
    throw new Error("token expired or invalid");
  }
  throw apiErr;
}
for (const pr of data.pullRequests) {
  console.log(`${pr.repo}#${pr.number}: ${pr.title} (${pr.ci})`);
}
```

每一次行动都一样 `client.GET`编号 :`client.POST`/.图案. 使用 `decodeError` 将任何失败的回复变成 `@forge-dashboard/sdk-node` `ApiError` 统一,如上所示.

客户端重复 `429` 或者说 `5xx` 以指数反转和 jitter( 尊重服务器的许可) `Retry-After`),并且不再重复其他任何内容 `4xx`{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}用这个 `retry` 选项,或交换基础 `fetch` 完全与 `fetch` 选项.

## 重新生成类型

见 [捐款额](https://npmcn.com/package/%40forge-dashboard/sdk-node/CONTRIBUTING.md) - 生成的种类被固定在一个 特定的伪造的活板 不应该默默地从中漂出.

## 捐款

见 [捐款额](https://npmcn.com/package/%40forge-dashboard/sdk-node/CONTRIBUTING.md) 用于建造、测试和释放 进程.

## 许可证

[麻省理工学院](https://npmcn.com/package/%40forge-dashboard/sdk-node/LICENSE) - 客户许可,不受 伪造dashboard自己的AGPL-3.0. 页:1

## 常见问题

### @forge-dashboard/sdk-node 是什么？

用于伪造dashboard的REST API的节点/TypeScript客户端,由它的OpenAPI spec生成\.

### 如何安装 @forge-dashboard/sdk-node？

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

### @forge-dashboard/sdk-node 支持 TypeScript 吗？

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

### @forge-dashboard/sdk-node 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @forge-dashboard/sdk-node 需要什么版本的 Node\.js？

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

### @forge-dashboard/sdk-node 可以商用吗？

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

### @forge-dashboard/sdk-node 的下载量有多少？

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

### @forge-dashboard/sdk-node 还在维护吗？

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