# @cocreate/socket-client 中文文档

规范地址：https://npmcn.com/package/%40cocreate/socket-client/

版本：2\.0\.1
npm 元数据更新时间：2026-11-05T23:53:25.987Z
中文译文更新时间：2026-11-10T07:08:09.327Z
软件包许可：AGPL-3\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cocreate/socket-client
原文对照：https://npmcn.com/package/%40cocreate/socket-client/?lang=original
项目主页：https://cocreatejs.com/docs/socket
源码仓库：https://github.com/CoCreateJS/socket-client

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

- 包体积（解压后）：204 kB，16 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：5 个
- 首次发布：2021-04-02T21:53:34.416Z
- 最新版本发布：2026-11-05T23:53:25.832Z
- 近 30 天下载量：2492（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：316（近 12 个月 10 个）

## 中文简介

香草javascript中简单的套接字组件 。 使用 HTML5 属性和/或 JavaScript API 轻松配置.

## 安装

```sh
npm install @cocreate/socket-client
```

也可以使用：`pnpm add @cocreate/socket-client`、`yarn add @cocreate/socket-client`、`bun add @cocreate/socket-client`

## README

# 创建- 锁定- 客户端

香草javascript中简单的套接字组件 。 使用 HTML5 属性和/或 JavaScript API 轻松配置. 把它当作我们的旋转 [游乐场!](https://cocreatejs.com/docs/socket-client)

![minified](https://img.badgesize.io/https://cdn.CoCreateJS.com/socket-client/latest/CoCreate-socket-client.min.js?style=flat-square&label=minified&color=orange) ![gzip](https://img.badgesize.io/https://cdn.CoCreateJS.com/socket-client/latest/CoCreate-socket-client.min.js?compression=gzip&style=flat-square&label=gzip&color=yellow) ![brotli](https://img.badgesize.io/https://cdn.CoCreateJS.com/socket-client/latest/CoCreate-socket-client.min.js?compression=brotli&style=flat-square&label=brotli) ![GitHub latest release](https://img.shields.io/github/v/release/CoCreateJS/socket-client?style=flat-square) ![License](https://img.shields.io/github/license/CoCreateJS/socket-client?style=flat-square) ![Hiring](https://img.shields.io/static/v1?style=flat-square&label=&message=Hiring&color=blueviolet)

![CoCreate-socket-client](https://cdn.cocreatejs.com/docs/CoCreate-socket-client.gif)

## [文档和演示](https://cocreatejs.com/docs/socket-client)

完整的指南和工作演示请参见 [贴花](https://cocreatejs.com/docs/socket-client)

## 光盘N

```html
<script src="https://cdn.CoCreateJS.com/socket-client/latest/CoCreate-socket-client.min.js"></script>
```

```html
<script src="https://cdn.CoCreateJS.com/socket-client/latest/CoCreate-socket-client.min.css"></script>
```

## 国家预防机制

```shell
$ npm i @cocreate/socket-client
```

## 线条

```shell
$ yarn install @cocreate/socket-client
```

# 目录

-   [目录](https://npmcn.com/package/%40cocreate/socket-client/#readme-table-of-contents)
-   [使用量](https://npmcn.com/package/%40cocreate/socket-client/#readme-usage)
-   [信件路径](https://npmcn.com/package/%40cocreate/socket-client/#readme-message-routing)
-   [浏览器- 文本发送](https://npmcn.com/package/%40cocreate/socket-client/#readme-browser-context-delivery)
-   [通知](https://npmcn.com/package/%40cocreate/socket-client/#readme-announcements)
-   [路线图](https://npmcn.com/package/%40cocreate/socket-client/#readme-roadmap)
-   [如何贡献](https://npmcn.com/package/%40cocreate/socket-client/#readme-how-to-contribute)
-   [关于](https://npmcn.com/package/%40cocreate/socket-client/#readme-about)
-   [许可证](https://npmcn.com/package/%40cocreate/socket-client/#readme-license)

# 使用量

信件使用一个信封. 这个 `method` 选择事件或操作,其余特性包含其有效载荷.

```js
import socket from "@cocreate/socket-client";

const response = await socket.send({
    method: "notification",
    message: "The workspace was updated",
    broadcast: false,
    broadcastClient: true
});
```

套接字客户端自动提供连接元数据,包括 `clientId`, (中文(简体) ), `frameId`, (中文(简体) ), `socketId`, (中文(简体) ), `organization_id`, (中文(简体) ), `uuid`,以及 `timeStamp`。 。 。 .

# 信件路径

-   `clientId` 识别浏览器,并与其标签、窗口和同源框架共享.
-   `frameId` 识别一个套接字客户端运行时间,例如标签、窗口或iframe.
-   `socketId` 识别单个 WebSocket 实例。 它为每个套接字生成,不通过会话存储共享 .
-   `broadcast` 控制服务器发送. `false` 瞄准原客户端或选定的客户端; `true` 目标是本组织内符合资格的客户.
-   `broadcastClient` 控制接收到的服务器消息是否被转发到浏览器的其他同源上下文.
-   `broadcastSender: false` 防止发端帧为响应发射出正常方法的收听器. 反应仍然回放,并解决了UUID的承诺.

套接字服务器向每个选中的连接的套接字发送 `clientId`如果无法达到一个套接字,它可以尝试属于该客户端的另一个套接字。 浏览器- 折叠文本分发由 socket- 客户端处理, 当 `broadcastClient` 已启用.

# 浏览器- 文本发送

套接力客户将完整的中继有效载荷储存在 `localSocketMessages` 共享数组 `system` 索引DB数据库. 这个 `messageQueue` 数组使用相同的内部数据库。 记录保留 `organization_id` 用于组织范围过滤,而应用程序数据库没有套接字传输状态。 Socket-客户端只将记录的ID和组织ID写到 `localSocketMessage` 本地存储键,允许其他上下文在不受本地存储值限制的情况下获取消息.

当地人 `storage` 事件火灾发生在其他同源情况下,而不是发生在执行写作的背景。 接收的上下文读取了索引数据库的记录并解雇了本地的听众。 每个新的中继器也会去除超过5秒的记录.

# 通知

图书馆的所有更新都记录在我们 [变化](https://github.com/CoCreateJS/socket-client/blob/master/CHANGELOG.md) 财务报告和审定财务报表 [释放](https://github.com/CoCreateJS/socket-client/releases)。您也可以订阅电子邮件以发布和中断更改.

# 路线图

如果你对这个项目的未来方向有兴趣, 请看看我们的开放 [问题](https://github.com/CoCreateJS/socket-client/issues) 财务报告和审定财务报表 [拖动请求](https://github.com/CoCreateJS/socket-client/pulls)我们想听听你的反馈.

# 关于

CoCreate-socket-client由CoCreate开发者经验团队指导和支持.

请发电子邮件给开发者体验团队 [这里](mailto:develop@CoCreateJS.com) 如果有任何疑问.

Coreate-socket-client由CoCreate维护和资助. CoCreate的名称和标志是CoCreate,LLC的商标.

# 如何贡献

我们鼓励为我们的图书馆捐款(你甚至可能得分) [捐款](https://github.com/CoCreateJS/socket-client/blob/master/CONTRIBUTING.md) 详细指南.

我们希望这个图书馆由社区驱动, Coreate 领导。 我们需要你的帮助来实现这一目标。 为了帮助确保我们按正确的顺序建造正确的东西,我们请你们创造 [问题](https://github.com/CoCreateJS/socket-client/issues) 财务报告和审定财务报表 [拖动请求](https://github.com/CoCreateJS/socket-client/pulls) 或只是对现有问题进行投票或发表意见或提出请求.

我们感谢你的继续支持,谢谢!

# 许可证

该软件在GNU Affero通用公共许可证版本3(AGPLv3)和商业许可证下获得双许可证.

-   **开源使用**:用于开源项目和非商业用途,此软件可在AGPLv3下提供. AGPLv3允许您自由使用,修改并分发此软件,前提是所有修改和衍生作品也根据AGPLv3获得许可. 营业执照全文见 [自由文件](https://github.com/CoCreateJS/socket-client/blob/master/LICENSE)。 。 。 .
    
-   **商业用途**: 意图将这一软件用于商业目的的营利性公司和个人必须获得商业许可证。 商业执照,当你签到 API 密钥我们 [网站](https://cocreatejs.com/)。该许可证允许对软件进行专有使用和修改,而不需要AGPLv3的左取要求。 将这一软件融入专有商业产品和应用是理想的.
    

如果您没有购买商业许可证,并打算将这个软件用于商业目的,请到我们的网站上注册API密钥.

## 常见问题

### @cocreate/socket-client 是什么？

香草javascript中简单的套接字组件 。 使用 HTML5 属性和/或 JavaScript API 轻松配置\.

### 如何安装 @cocreate/socket-client？

在项目目录运行 npm install @cocreate/socket-client，或使用 pnpm add / yarn add / bun add。

### @cocreate/socket-client 支持 TypeScript 吗？

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

### @cocreate/socket-client 支持 ESM 还是 CommonJS？

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

### @cocreate/socket-client 可以商用吗？

@cocreate/socket-client 使用 AGPL-3\.0 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @cocreate/socket-client 的下载量有多少？

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

### @cocreate/socket-client 还在维护吗？

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