Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

crossws

h3js7.4mMIT0.3.5TypeScript support: included

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

readme

crossws

npm version npm downloads

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

👉 📖 documentation

Features

🧩 Seamlessly integrates with Bun, Cloudflare Workers, Deno and Node.js and any compatible web framework.

✅ Prebundled with ws for Node.js support with alternative/much faster 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 (prebundled) or uWebSockets.js.

Contribution

<summary>Local development</summary>
  • Clone this repository
  • Install the latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run examples using pnpm play: scripts

License

Published under the MIT license. Made by @pi0 and community 💛

🤖 auto updated with automd