# @atom\.io/realtime 中文文档

规范地址：https://npmcn.com/package/%40atom.io/realtime/

版本：0\.1\.1
npm 元数据更新时间：2026-10-29T08:33:28.000Z
中文译文更新时间：2026-11-07T03:16:28.573Z
软件包许可：MPL-2\.0

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

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

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

- 包体积（解压后）：3.9 MB，187 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，atom\.io ^0\.54\.0，lexical \>=0\.49\.0，happy-dom \>=17\.4\.4，react-dom ^18\.0\.0 \|\| ^19\.0\.0，socket\.io \>=4\.0\.0，@types/react ^18\.0\.0 \|\| ^19\.0\.0，@atom\.io/react ^0\.2\.0，@lexical/react \>=0\.49\.0，socket\.io-client \>=4\.0\.0，@lexical/selection \>=0\.49\.0，@testing-library/react \>=14\.0\.0
- 首次发布：2026-10-23T07:19:46.623Z
- 最新版本发布：2026-10-29T08:33:27.518Z
- 近 30 天下载量：4337（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

实时协作,客户端,服务器,以及Atom.io的测试.

## 安装

```sh
npm install @atom.io/realtime
```

也可以使用：`pnpm add @atom.io/realtime`、`yarn add @atom.io/realtime`、`bun add @atom.io/realtime`

## README

![atom.io logo](https://raw.githubusercontent.com/jeremybanka/atom.io/main/apps/atom.io.fyi/public/favicon.png)

# `@atom.io/realtime`

[![NPM Version](https://img.shields.io/npm/v/@atom.io/realtime?style=for-the-badge)](https://www.npmjs.com/package/@atom.io/realtime)[![Dependencies 0](https://img.shields.io/badge/dependencies-0-0?style=for-the-badge)](https://www.npmjs.com/package/@atom.io/realtime)[![Coverage](https://img.shields.io/endpoint?url=https%3A%2F%2Frecoverage.cloud%2Fshields%2F665Gbgm4N5b47w7qpruIa%2Frealtime)](https://recoverage.cloud/)[![Types](https://img.shields.io/npm/types/@atom.io/realtime?style=for-the-badge)](https://www.npmjs.com/package/@atom.io/realtime)

### Atom.io的实时协作.

### [读取 attom.io.fyi 的文档](https://atom.io.fyi/docs/realtime)

同时安装 `atom.io` 0.54或后为0.54放行. 框架、渲染器、运输和测试环境同位素是可选的,取决于所使用的切入点.

| 入境点 | 目的 | 其他同行 |
| --- | --- | --- |
| `@atom.io/realtime` | 共享协议、 Mosaic 模型和域 | 无 |
| `@atom.io/realtime/client` | 框架中立同步 | 无 |
| `@atom.io/realtime/server` | 节点服务器、存储和进程后置房间 | 袜子。 苏克特号的IO. IO 服务器 API |
| `@atom.io/realtime/react` | 反应生命周期约束 | `@atom.io/react`,反应 18 或 19;匹配类型脚本的反应类型 |
| `@atom.io/realtime/react/lexical` | 语法编辑器适配器 | 反应,反应DOM,Lexical, `@lexical/react`, (中文(简体) ), `@lexical/selection` |
| `@atom.io/realtime/testing/headless` | 无渲染器方案 | 袜子。 IO和 `socket.io-client` |
| `@atom.io/realtime/testing/react` | 设想方案 | 无头同辈加 `@atom.io/react`,反应,反应DOM,测试库,快乐DOM |

指南和打字的物证在本包中直播 `docs/source` 目录。 React和客户端API消耗了共享运输合同;一个Cloudflare服务器适配器仍然是未来的工作.

迁移:替换 `atom.io/realtime` 与 `@atom.io/realtime`替换旧的 `realtime-client`, (中文(简体) ), `realtime-server`, (中文(简体) ), `realtime-react`, (中文(简体) ), `realtime-react-lexical`,以及 `realtime-testing/*` 与以上相应条目相连接的子路径 。 核心SDK不再实时出口. 没有兼容性再导出从 `atom.io` 回到这个包裹.

## 常见问题

### @atom\.io/realtime 是什么？

实时协作,客户端,服务器,以及Atom\.io的测试\.

### 如何安装 @atom\.io/realtime？

在项目目录运行 npm install @atom\.io/realtime，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：atom\.io（^0\.54\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atom\.io/realtime 支持 TypeScript 吗？

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

### @atom\.io/realtime 支持 ESM 还是 CommonJS？

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

### @atom\.io/realtime 可以商用吗？

@atom\.io/realtime 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @atom\.io/realtime 的下载量有多少？

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

### @atom\.io/realtime 还在维护吗？

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