# @dobeacon/sdk 中文文档

规范地址：https://npmcn.com/package/%40dobeacon/sdk/

版本：2\.18\.5
npm 元数据更新时间：2026-11-09T12:25:56.293Z
中文译文更新时间：2026-11-12T13:43:13.617Z
软件包许可：SEE LICENSE IN LICENSE

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

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

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

- 包体积（解压后）：565 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2026-10-26T21:34:29.109Z
- 最新版本发布：2026-11-09T12:25:56.009Z
- 近 30 天下载量：2685（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

DoBeacon 导游SDK——在任何网站上嵌入导游

## 安装

```sh
npm install @dobeacon/sdk
```

也可以使用：`pnpm add @dobeacon/sdk`、`yarn add @dobeacon/sdk`、`bun add @dobeacon/sdk`

## README

# @ dobeacon/ sdk (英语)

导游、网页助手和您的网络应用信息,由 [多比肯语Name](https://dobeacon.com/)在Dobeacon仪表板或Chrome中构建巡演 扩展; 此软件包在您的网站上播放 .

## 安装

```sh
npm install @dobeacon/sdk
```

## 开始

打电话 `init` 一次,在浏览器中,与您的工程密钥(Dashboard ~您的工程 ~) 安装). 关键是设计上的公开:它只读已出版的旅游和邮递活动.

```js
import DoBeacon from '@dobeacon/sdk';

DoBeacon.init('pk_live_YOUR_KEY');
```

在 Next.js 或任何服务器授权的应用程序中,仅使用客户端调用:

```js
if (typeof window !== 'undefined') {
  DoBeacon.init(process.env.NEXT_PUBLIC_DOBEACON_KEY);
}
```

然后,一旦你的签到决定, 告诉多比康谁是访客:

```js
DoBeacon.identify(user.id, { name: user.name, plan: user.plan });
```

## 喜欢脚本标签吗?

```html
<script src="https://dobeacon.com/v2/dobeacon.min.js" data-project-key="pk_live_YOUR_KEY" async></script>
```

## 文档

-   [用 npm 安装](https://dobeacon.com/docs/npm)
-   [SDK API 软件](https://dobeacon.com/docs/sdk/api) • 妇女 [活动](https://dobeacon.com/docs/sdk/events) • 妇女 [步骤类型](https://dobeacon.com/docs/sdk/step-types)

## 许可证

专有. 使用需要 Dobeacon 账户,并受 [Dobeacon 服务条件](https://dobeacon.com/terms)。见 `LICENSE`。 。 。 .

## 常见问题

### @dobeacon/sdk 是什么？

DoBeacon 导游SDK——在任何网站上嵌入导游

### 如何安装 @dobeacon/sdk？

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

### @dobeacon/sdk 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/dobeacon\_\_sdk 是否存在。

### @dobeacon/sdk 支持 ESM 还是 CommonJS？

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

### @dobeacon/sdk 可以商用吗？

@dobeacon/sdk 使用 SEE LICENSE IN LICENSE 许可。许可条款写在包内的独立文件中，请阅读该文件确认可否商用。以上为概括，不构成法律意见，请以许可原文为准。

### @dobeacon/sdk 的下载量有多少？

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

### @dobeacon/sdk 还在维护吗？

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