mirror of
https://github.com/oven-sh/bun
synced 2026-02-12 11:59:00 +00:00
32 lines
651 B
Markdown
32 lines
651 B
Markdown
---
|
|
name: Enable compression for WebSocket messages
|
|
---
|
|
|
|
Per-message compression can be enabled with the `perMessageDeflate` parameter. When set, all messages will be compressed using the [permessage-deflate](https://tools.ietf.org/html/rfc7692) WebSocket extension.
|
|
|
|
```ts
|
|
Bun.serve({
|
|
// ...
|
|
websocket: {
|
|
// enable compression
|
|
perMessageDeflate: true,
|
|
},
|
|
});
|
|
```
|
|
|
|
---
|
|
|
|
To enable compression for individual messages, pass `true` as the second parameter to `ws.send()`.
|
|
|
|
```ts
|
|
Bun.serve({
|
|
// ...
|
|
websocket: {
|
|
async message(ws, message) {
|
|
// send a compressed message
|
|
ws.send("Hello world!", true);
|
|
},
|
|
},
|
|
});
|
|
```
|