# @zenweb/websocket

> Zenweb WebSocket module

Latest version **3.4.0** (published 2026-04-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @zenweb/websocket
pnpm add @zenweb/websocket
yarn add @zenweb/websocket
bun add @zenweb/websocket
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 3.4.0 |
| Published | 2026-04-21 |
| First published | 2022-12-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 19.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | YeFei |
| Maintainers | yefei777 |
| Keywords | web, app, http, framework, koa, websocket |

## Links

- npm: https://www.npmjs.com/package/@zenweb/websocket
- Homepage: https://zenweb.node.ltd
- npm.io page: https://npm.io/package/@zenweb/websocket

## Dependencies (5)

- [ws](https://npm.io/package/ws.md) ^8.20.0
- [@types/ws](https://npm.io/package/@types/ws.md) ^8.18.1
- [koa-compose](https://npm.io/package/koa-compose.md) ^4.1.0
- [@zenweb/core](https://npm.io/package/@zenweb/core.md) ^5.3.0
- [@zenweb/inject](https://npm.io/package/@zenweb/inject.md) ^5.4.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.4.0 (latest) — 2026-04-21
- 3.3.0 — 2026-04-10
- 3.2.0 — 2024-10-17
- 3.1.0 — 2024-10-12
- 3.0.0 — 2024-10-11
- 2.3.1 — 2024-09-25
- 2.3.0 — 2024-09-10
- 2.2.0 — 2024-07-08
- 2.1.0 — 2024-07-03
- 2.0.0 — 2024-07-03
- 1.2.0 — 2022-12-07
- 1.1.0 — 2022-12-06
- 1.0.1 — 2022-12-05
- 1.0.0 — 2022-12-05

## README

# ZenWeb WebSocket module

[ZenWeb](https://www.npmjs.com/package/zenweb)

websocket 模块 - 支持分布式 websocket 会话共享

```ts
import { $debug, $query, Context, Get } from 'zenweb';
import { WebSocket, RedisSocketSession } from '@zenweb/websocket';

export class Controller {
  @Get()
  index(ctx: Context) {
    ctx.template('index.njk');
    return { name: 'Hello' };
  }

  @Get()
  async ws(ws: WebSocket, ss: RedisSocketSession) {
    $debug('websocket 连接');
    const { name } = await $query.get({ name: '!trim1' });
    const room = 'chat';
    await ss.add(room, ws);
    ss.send(room, `欢迎 ${name} 来到聊天室！`);
    ws.once('close', () => {
      ss.send(room, `${name} 离开了聊天室！`);
    });
    ws.on('message', data => {
      const str = data.toString();
      ss.send(room, name + ': ' + str);
    });
  }
}
```

---
_Source: https://npm.io/package/@zenweb/websocket · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
