https://github.com/unjs/crossws

🔌 Cross-platform WebSocket Servers for Node.js, Deno, Bun and Cloudflare Workers.
https://github.com/unjs/crossws

Last synced: 4 months ago
JSON representation

🔌 Cross-platform WebSocket Servers for Node.js, Deno, Bun and Cloudflare Workers.

• Host: GitHub
• URL: https://github.com/unjs/crossws
• Owner: unjs
• License: other
• Created: 2023-12-07T00:41:31.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-13T18:46:57.000Z (10 months ago)
• Last Synced: 2024-04-14T08:55:31.472Z (10 months ago)
• Language: TypeScript
• Homepage: https://crossws.unjs.io
• Size: 839 KB
• Stars: 220
• Watchers: 4
• Forks: 3
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# crossws

[![npm version](https://flat.badgen.net/npm/v/crossws)](https://npmjs.com/package/crossws)

[![npm downloads](https://flat.badgen.net/npm/dm/crossws)](https://npmjs.com/package/crossws)

Elegant, typed, and simple toolkit to implement cross-platform WebSocket servers.

👉 [📖 documentation](https://crossws.unjs.io)

## Features

🧩 Seamlessly integrates with [Bun](https://crossws.unjs.io/adapters/bun), [Cloudflare Workers](https://crossws.unjs.io/adapters/cloudflare), [Deno](https://crossws.unjs.io/adapters/deno) and [Node.js](https://crossws.unjs.io/adapters/node) and any compatible web framework.

✅ Prebundled with [ws](https://github.com/websockets/ws) for Node.js support with alternative/much faster [uWebSockets](https://crossws.unjs.io/adapters/node#uwebsockets) adapter.

📦 Extremely lightweight and tree-shakable conditional ESM exports.

🚀 High-performance and simple hooks API, without per-connection callback creation.

🌟 Typed hooks API and developer-friendly object inspection.

[^1]: crossws supports Node.js via [npm:ws](https://github.com/websockets/ws) (prebundled) or [uWebSockets.js](https://github.com/uNetworking/uWebSockets.js).

## Contribution

  Local development

- Clone this repository

- Install the latest LTS version of [Node.js](https://nodejs.org/en/)

- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`

- Install dependencies using `pnpm install`

- Run examples using `pnpm play:` scripts

## License

Published under the [MIT](https://github.com/unjs/crossws/blob/main/LICENSE) license.

Made by [@pi0](https://github.com/pi0) and [community](https://github.com/unjs/crossws/graphs/contributors) 💛











---

_🤖 auto updated with [automd](https://automd.unjs.io)_