# @dialstack/sdk-js 中文文档

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

版本：3\.10\.0
npm 元数据更新时间：2026-11-09T16:42:16.659Z
中文译文更新时间：2026-11-12T06:38:31.948Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：4.3 MB，49 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-08-10T15:24:21.165Z
- 最新版本发布：2026-11-09T16:42:16.461Z
- 近 30 天下载量：4007（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

DialStack 浏览器 SDK — 初始化, REST 客户端和自注册的网络组件

## 安装

```sh
npm install @dialstack/sdk-js
```

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

## README

# @dialstack/sdk-js (英语)

DialStack 浏览器 SDK —— 初始化, REST 客户端, 以及 6 自注册的网络组件.

普通的 HTML 或 JavaScript 页面需要的一切 。 反应捆绑在 [`@dialstack/sdk-react`](https://www.npmjs.com/package/@dialstack/sdk-react), (中文(简体) ), 软件包上的哪个对等者.

## 安装

```bash
npm install @dialstack/sdk-js
```

或者从一个 `<script>` 标签,不需要捆绑:

```html
<script src="https://unpkg.com/@dialstack/sdk-js"></script>
```

剧本显示一切 `window.DialStack`。 。 。 .

## 使用量

```ts
import { loadDialstackAndInitialize } from '@dialstack/sdk-js';

const dialstack = await loadDialstackAndInitialize({
  publishableKey: 'pk_live_…',
  fetchClientSecret: async () => {
    const res = await fetch('/api/dialstack-session', { method: 'POST' });
    return (await res.json()).client_secret;
  },
});
```

```html
<dialstack-call-logs></dialstack-call-logs> <dialstack-voicemails></dialstack-voicemails>
```

## 导入此软件包会登记元素

这是一种副作用,而且是故意的:入境点每个进口 组件模块,每个模块都以 `customElements.define(...)`。所以一个 `import '@dialstack/sdk-js'` 是什么让 `<dialstack-call-logs>` 一个真正的元素 而不是一个惰性的未知的.

二事随顺.

**`sideEffects` 是一个许可列表,不是 `false`。 。 。 .** 一条被子 `false` 会让一个 捆绑商将那些进口品作为未使用品丢弃,失败是沉默的—— `document.createElement` 未注册标记成功, 返回元素 毫无错误 如果你是卖家 或重新捆绑这个 包,保留那个字段.

**使用 `./pure` 当你不希望副作用.** 同样的表面,什么都没有 导入时注册; 您调用 `registerComponents()` 你自己来 这就是你 想要用于服务器侧渲染,测试,以及任何模块级 `customElements.define` 会运行太早 或在错误的领域.

```ts
import { registerComponents, loadDialstackAndInitialize } from '@dialstack/sdk-js/pure';

if (typeof window !== 'undefined') registerComponents();
```

## 错误

抓取 API 失败 `isApiError`没有 `instanceof ApiError`数字 :

```ts
import { isApiError } from '@dialstack/sdk-js';

try {
  await dialstack.phoneNumbers.list();
} catch (err) {
  if (isApiError(err) && err.status === 409) {
    /* … */
  }
}
```

`instanceof` 比较一个特定的类对象,所以返回假 当此套件的两份副本最终出现在树上时, 或当错误跨越 a 领域. `isApiError` 读取错误本身上所带的字段,但不能扭曲.

## 我要哪个包裹?

| 你在建楼 | 安装 |
| --- | --- |
| 一个简单的 HTML 页面 | 仅此软件包 |
| 带有 DialStack UI 的回放应用程序 | 此软件包+ `@dialstack/sdk-react` |
| 任何框架中的软音 | `@dialstack/sdk-webrtc` |
| 节点后端 | `@dialstack/sdk-server` |

## 文档

完整文档: [https://docs.dialstack.ai/sdks (中文(简体) )](https://docs.dialstack.ai/sdks)

## 许可证

麻省理工学院

## 常见问题

### @dialstack/sdk-js 是什么？

DialStack 浏览器 SDK — 初始化, REST 客户端和自注册的网络组件

### 如何安装 @dialstack/sdk-js？

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

### @dialstack/sdk-js 支持 TypeScript 吗？

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

### @dialstack/sdk-js 支持 ESM 还是 CommonJS？

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

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

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

### @dialstack/sdk-js 可以商用吗？

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

### @dialstack/sdk-js 的下载量有多少？

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

### @dialstack/sdk-js 还在维护吗？

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