From 4c89c60867591b50e0b31bf5009fd5ad6a3cebe1 Mon Sep 17 00:00:00 2001 From: Colin McDonnell Date: Wed, 26 Jul 2023 14:59:39 -0700 Subject: Add files (#3826) --- docs/guides/websocket/compression.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 docs/guides/websocket/compression.md (limited to 'docs/guides/websocket/compression.md') diff --git a/docs/guides/websocket/compression.md b/docs/guides/websocket/compression.md new file mode 100644 index 000000000..e98d8f0c9 --- /dev/null +++ b/docs/guides/websocket/compression.md @@ -0,0 +1,31 @@ +--- +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); + }, + }, +}); +``` -- cgit v1.2.3