# @dskripchenko/realtime 中文文档

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

版本：0\.1\.0
npm 元数据更新时间：2026-10-31T20:59:50.314Z
中文译文更新时间：2026-11-01T00:46:47.047Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dskripchenko/realtime
原文对照：https://npmcn.com/package/%40dskripchenko/realtime/?lang=original
项目主页：https://github.com/dskripchenko/laravel-realtime/tree/main/js
源码仓库：https://github.com/dskripchenko/laravel-realtime

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

- 包体积（解压后）：67.5 kB，27 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-10-31T20:56:41.873Z
- 最新版本发布：2026-10-31T20:59:50.020Z
- 已发布版本数：2（近 12 个月 2 个）

## 中文简介

浏览器客户端为dskripchenko/ larvel -实时：票，重新连接后退，重放按序列号，存在。零运行时依赖项。

## 安装

```sh
npm install @dskripchenko/realtime
```

也可以使用：`pnpm add @dskripchenko/realtime`、`yarn add @dskripchenko/realtime`、`bun add @dskripchenko/realtime`

## README

# @dskripchenko /实时

浏览器客户端 [dskripchenko / laravel-realtime](https://github.com/dskripchenko/laravel-realtime). TypeScript， ESM，零运行时依赖。

```ts
import { RealtimeClient } from '@dskripchenko/realtime';

const realtime = new RealtimeClient({ ticketUrl: '/realtime/ticket' });
realtime.connect();

const board = realtime.private<{ CardMoved: { id: number; column: string } }>('board.42');
board.on('CardMoved', (card, meta) => console.log(card.id, 'moved, seq', meta.seq));
board.onResync(() => reloadBoard());

const page = realtime.join<{}, { name: string }>('page.7');
page.onMembers((members) => renderAvatars(members));
```

特点：基于票证的连接，重新连接指数回退和抖动，自动 重新订阅从最后的序列号，存在，客户端事件的重播 （`whisper`)、keepalive、类型化事件处理程序。

完整的文档: [文档/ en / js-client.md](https://github.com/dskripchenko/laravel-realtime/blob/main/docs/en/js-client.md).

许可协议:麻省理工学院。

## 常见问题

### @dskripchenko/realtime 是什么？

浏览器客户端为dskripchenko/ larvel -实时：票，重新连接后退，重放按序列号，存在。零运行时依赖项。

### 如何安装 @dskripchenko/realtime？

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

### @dskripchenko/realtime 支持 TypeScript 吗？

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

### @dskripchenko/realtime 支持 ESM 还是 CommonJS？

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

### @dskripchenko/realtime 需要什么版本的 Node\.js？

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

### @dskripchenko/realtime 可以商用吗？

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

### @dskripchenko/realtime 还在维护吗？

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