tinyws is a WebSocket middleware for Node.js based on ws, inspired by koa-easy-ws.
Check the chat example out to get familiar with tinyws.
- Small size (498B)
- Easy to use (only
req.ws
and nothing else) - Framework-agnostic (works with tinyhttp, express etc)
- Written in TypeScript
- Pure ESM
Why not express-ws?
because express-ws is...
- Abandoned since 2018 ๐
- Doesn't come with types out of the box (have to install
@types/express-ws
) - Not compatible with tinyhttp and polka
- Buggy as hell
- Doesn't have tests
pnpm i ws tinyws
import { App, Request } from '@tinyhttp/app'
import { tinyws, TinyWSRequest } from 'tinyws'
const app = new App<any, Request & TinyWSRequest>()
app.use(tinyws())
app.use('/ws', async (req, res) => {
if (req.ws) {
const ws = await req.ws()
return ws.send('hello there')
} else {
res.send('Hello from HTTP!')
}
})
app.listen(3000)
See examples for express and polka integration.