# @captionhub/captionhub-node-sdk 中文文档

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

版本：1\.3\.0
npm 元数据更新时间：2026-10-02T11:40:25.060Z
中文译文更新时间：2026-11-09T12:25:56.539Z
软件包许可：https://www\.captionhub\.com/user-terms

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

原始 npm 页面：https://www.npmjs.com/package/%40captionhub/captionhub-node-sdk
原文对照：https://npmcn.com/package/%40captionhub/captionhub-node-sdk/?lang=original
项目主页：https://www.captionhub.com/

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

- 包体积（解压后）：252 kB，43 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2025-11-27T19:23:15.560Z
- 最新版本发布：2026-10-02T11:40:24.854Z
- 近 30 天下载量：2756（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：20（近 12 个月 20 个）

## 中文简介

CaptionHub 的 API 脚本 SDK 类型

## 安装

```sh
npm install @captionhub/captionhub-node-sdk
```

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

## README

# 标题Hub 节点 SDK

用于CaptionHub API的节点TypeScript SDK,其方法为CaptionHub API端点,响应类型,webhook类型和Timbra WebSocket API.

## 安装

您可以通过 npm 安装 SDK :

```bash
npm install @captionhub/captionhub-node-sdk
```

或者说

```bash
yarn add @captionhub/captionhub-node-sdk
```

## 与 API 交互

以下是如何使用CaptionHub SDK的一个简单的例子:

```ts
import { CaptionHub } from '@captionhub/captionhub-node-sdk';

const client = new CaptionHub('YOUR_API_KEY');

const projects = await client.projects.getProjects();

console.log('Projects:', projects);
```

[查看所有可用的方法](https://app.captionhub.com/docs/captionhub-node-sdk/classes/captionhub.CaptionHub/)

如果 API 返回一个不可胜数的响应( 即 4xx 或 5xx 响应), 一个子类: `CaptionHub.APIError` 将扔出 :

```ts
try {
  await client.projects.getProject('i-404');
} catch (err) {
  if (err instanceof CaptionHub.APIError.NotFoundError) {
    console.error(`API Error: ${err.status} - ${err.message}`);
    console.error('Response data:', err.data);
  } else if (err instanceof CaptionHub.APIError) {
    console.error(`API Error: ${err.status} - ${err.message}`);
    console.error('Response data:', err.data);
  } else {
    console.error('Unexpected error:', err);
  }
}
```

## API 响应类型

如果您只想要使用 SDK 中定义的类型, 您可以直接导入 :

```ts
import { type APITypes } from '@captionhub/captionhub-node-sdk';

async function main() {
  const project: Partial<APITypes.Project> = {
    name: 'Your project',
  };

  console.log('Project:', project);
}
```

[查看所有可用的类型](https://app.captionhub.com/docs/captionhub-node-sdk/modules/captionhub.APITypes/)

## Webhook 类型

使用 `WebhookEvent` 类型以强烈键入您的 webhook 处理器 :

```ts
import { type WebhookEvent } from '@captionhub/captionhub-node-sdk';

function handleWebhook(event: WebhookEvent) {
  if (event.type === 'project.created') {
    // Now `event.data.project` is strongly typed as `APITypes.Project`
    console.log('Project created with ID:', event.data.project.id);
  }
}
```

[查看所有 Webhook 事件类型](https://app.captionhub.com/docs/captionhub-node-sdk/modules/captionhub.WebhookEvent/)

## 蒂姆布拉 WebSocket API

使用 Timbra 的 WebSocket API 通过 WebSocket 连接接收字幕 .

```ts
const captionhub = new CaptionHub("YOUR_API_KEY", "http://localhost");

captionhub.timbra.startFlow("example-timbra-project");

const connectionDetails = await captionhub.timbra.getConnectionDetails("example-timbra-project");

captionhub.timbra.subscribe({
  connection: connectionDetails,
  onCaption: (event: CaptionsEvent) => {
    console.log("Received captions:", event);
  }
});
```

见 [标题事件](https://app.captionhub.com/docs/captionhub-node-sdk/types/timbra.CaptionsEvent/) 为有效载荷.

## 支助和反馈

提高支持票在 [说明Hub 支持](https://www.captionhub.com/support)。 。 。 .

## 许可证

[CaptionHub 用户术语和许可证](https://www.captionhub.com/user-terms)

## 常见问题

### @captionhub/captionhub-node-sdk 是什么？

CaptionHub 的 API 脚本 SDK 类型

### 如何安装 @captionhub/captionhub-node-sdk？

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

### @captionhub/captionhub-node-sdk 支持 TypeScript 吗？

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

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

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

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

@captionhub/captionhub-node-sdk 使用 https://www\.captionhub\.com/user-terms 许可。声明的许可为 https://www\.captionhub\.com/user-terms，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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