# @basenative/realtime 中文文档

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

版本：3\.3\.0
npm 元数据更新时间：2026-11-03T01:39:39.961Z
中文译文更新时间：2026-11-08T08:33:19.544Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40basenative/realtime
原文对照：https://npmcn.com/package/%40basenative/realtime/?lang=original
项目主页：https://github.com/DuganLabs/BaseNative/tree/main/packages/realtime#readme
源码仓库：https://github.com/DuganLabs/BaseNative

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

- 包体积（解压后）：20.2 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-03-20T05:27:52.405Z
- 最新版本发布：2026-11-03T01:39:39.595Z
- 近 30 天下载量：1854（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

SSE 和 WebSocket 连接到基于信号的反应性消息流

## 安装

```sh
npm install @basenative/realtime
```

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

## README

# @ aslative/实时

> 服务器事件、 WebSocket 处理和命名频道管理

部分 [基础](https://github.com/DuganLabs/basenative) 生态系统——一个基于信号的网络运行时间超过本土的HTML.

## 安装

```bash
npm install @basenative/realtime
```

## 快速启动 — SSE

```js
import { createSSEServer, sseMiddleware } from '@basenative/realtime';
import { createPipeline } from '@basenative/middleware';

const sse = createSSEServer({ heartbeatInterval: 30_000 });

// Broadcast to all connected clients
sse.broadcast('update', { timestamp: Date.now() });

// SSE endpoint
const pipeline = createPipeline().use(sseMiddleware(sse));
```

## 快速启动 — 频道

```js
import { createChannelManager } from '@basenative/realtime';

const channels = createChannelManager();

// Subscribe
const unsub = channels.subscribe('room:42', (event, data) => {
  console.log(event, data);
});

// Publish
channels.publish('room:42', 'message', { text: 'Hello!' });

// Cleanup
unsub();
```

## 快速启动 — WebSockets

```js
import { createWSHandler } from '@basenative/realtime';

const ws = createWSHandler({
  onConnect(socket) { console.log('connected'); },
  onMessage(socket, message) { socket.send(message); },
  onClose(socket) { console.log('disconnected'); },
});

// Pass to your HTTP upgrade handler
server.on('upgrade', ws.handleUpgrade);
```

## API 密码

### `createSSEServer(options?)`

创建管理多个客户端连接的SSE服务器. 选项 : `heartbeatInterval` (ms,默认:3000).

回返情况:

-   `addClient(res, options?)` ——将响应流注册为SSE客户端. 返回客户端ID.
-   `removeClient(id)` ——删除客户端连接.
-   `send(clientId, event, data?)` ——向特定客户端发送事件.
-   `broadcast(event, data?)` ——向所有连接客户端发送事件.
-   `clients` ——连接客户端对象地图.

### `sseMiddleware(sseServer, options?)`

自动将收到的请求登记为SSE客户端的中端软件.

### `createChannelManager()`

创建一个命名为 pub/ sub 频道管理器 .

-   `subscribe(channel, handler)` ——订阅频道. 返回一个未订阅的函数 .
-   `publish(channel, event, data?)` ——向所有频道订阅者发布活动.
-   `unsubscribeAll(channel)` ——从频道中删除所有订阅者.

### `createWSHandler(options)`

创建 WebSocket 连接处理器。 选项 : `onConnect`, (中文(简体) ), `onMessage`, (中文(简体) ), `onClose`, (中文(简体) ), `onError`。 。 。 .

-   `handleUpgrade(req, socket, head)` ——Node.js HTTP升级事件处理器.

## 许可证

阿帕奇 - 2.0

## 常见问题

### @basenative/realtime 是什么？

SSE 和 WebSocket 连接到基于信号的反应性消息流

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

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

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

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

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

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

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

@basenative/realtime 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @basenative/realtime 的下载量有多少？

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

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

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