# @buoy-gg/sync-broker 中文文档

规范地址：https://npmcn.com/package/%40buoy-gg/sync-broker/

版本：7\.0\.87
npm 元数据更新时间：2026-11-07T01:50:44.813Z
中文译文更新时间：2026-11-08T20:07:31.384Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40buoy-gg/sync-broker
原文对照：https://npmcn.com/package/%40buoy-gg/sync-broker/?lang=original
项目主页：https://buoy.gg/
源码仓库：https://github.com/Buoy-gg/buoy

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

- 包体积（解压后）：77.6 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：1 个
- 首次发布：2026-06-30T15:42:14.540Z
- 最新版本发布：2026-11-07T01:50:44.625Z
- 近 30 天下载量：4513（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：92（近 12 个月 92 个）

## 中文简介

Buoy devtool同步协议(v1)的无头Socket.IO经纪人——设备与仪表板/MCP客户端之间的路由信息

## 安装

```sh
npm install @buoy-gg/sync-broker
```

也可以使用：`pnpm add @buoy-gg/sync-broker`、`yarn add @buoy-gg/sync-broker`、`bun add @buoy-gg/sync-broker`

## README

# @buoy-gg/sync-经纪人

主办"苏克特". Buoy桌面和MCP使用的IO消息路由器. 它引导设备能力,观看快照,以及设备客户端和仪表板客户端之间的远程动作. 大多数用户应该运行桌面或MCP,而不是直接托管这个软件包.

## 安装

```bash
npm install @buoy-gg/sync-broker
```

这是一个节点主机包。 使用导出 `createBroker`, (中文(简体) ), `socketHandle`,以及执行自定义主机时的协议类型.

## 主办经纪人

主办方必须独立验证其Buoy账户并通过 `canUseDesktop`。默认拒绝访问。 此集成草图预计您的主机已经存在 `account` 对象; `hasAccess()` 必须反映目前经核实的承认,而不仅仅是钥匙的存在:

```ts
import { createBroker, DEFAULT_BROKER_PORT } from "@buoy-gg/sync-broker";

const broker = createBroker({
  port: DEFAULT_BROKER_PORT,
  canUseDesktop: () => account.hasAccess(),
  onListening: (port) => console.log(`Broker listening on ${port}`),
  onError: (error) => console.error(error),
});

// Call when your account lifecycle changes admission:
broker.refreshAccess();

// Call during host shutdown:
await broker.close();
```

保持账户重新验证和过期处理活动,为主机终生服务. 访问更改时刷新路由 。 设备及客户端的录入与主机回调分离. 听取的 HTTP 端点不能证明一个设备已被允许 .

尝试连接到已有的经纪人, 然后再启动另一个 。 如果启动报告 EADDRIUSE, 请连接已经使用该端口的经纪人或解决冲突 。 默认端口是 `42831`。 。 。 .

## 已存在的 HTTP 服务器

对于一个现有的Socket。 IO 服务器, 使用 `socketHandle({ io, canUseDesktop })` 并保留其退还的 `refreshAccess` 函数。 您的主机拥有 HTTP 服务器 Socket. IO选项,账户生命周期,和关闭。 不将路由附加到同一服务器上两次 .

## 信件流

设备宣布能力. Dashboard watch 请求控制适配器订阅;经纪人合并这些请求. 设备快照流到观看客户端,而命名动作及其结果则向相反方向行走. 经纪人日志有助于诊断录入、连接和协议问题。 离线设备历史在记忆中,可以被遗忘或老化.

## 网络和核查

独立服务器在不设回放主机限制的情况下监听. 默认 CORS 允许任何来源; CORS 不是客户端认证 。 使用可信任的开发网络并审查访问控制,然后曝光超出它的自定义主机. 账户的录用并不为每一个远程动作规定具体应用授权.

用已核实的主机和设备账户进行测试:连接,监视已知工具,确认其快照. 后撤销主机接收,并核实访问关闭. 恢复有效访问后重新连接,并检查该表状态恢复 。 见 [桌面指南](https://buoy.gg/buoy/latest/docs/desktop) 财务报告和审定财务报表 [MCP 指南](https://buoy.gg/buoy/latest/docs/mcp) 用于支持的最终用户主机.

## 常见问题

### @buoy-gg/sync-broker 是什么？

Buoy devtool同步协议\(v1\)的无头Socket\.IO经纪人——设备与仪表板/MCP客户端之间的路由信息

### 如何安装 @buoy-gg/sync-broker？

在项目目录运行 npm install @buoy-gg/sync-broker，或使用 pnpm add / yarn add / bun add。

### @buoy-gg/sync-broker 支持 TypeScript 吗？

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

### @buoy-gg/sync-broker 支持 ESM 还是 CommonJS？

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

### @buoy-gg/sync-broker 需要什么版本的 Node\.js？

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

### @buoy-gg/sync-broker 可以商用吗？

@buoy-gg/sync-broker 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @buoy-gg/sync-broker 的下载量有多少？

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

### @buoy-gg/sync-broker 还在维护吗？

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