Files
bun.sh/docs/guides/websocket/compression.md
Colin McDonnell 4c89c60867 Add files (#3826)
2023-07-26 14:59:39 -07:00

651 B

name
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 WebSocket extension.

Bun.serve({
  // ...
  websocket: {
    // enable compression
    perMessageDeflate: true,
  },
});

To enable compression for individual messages, pass true as the second parameter to ws.send().

Bun.serve({
  // ...
  websocket: {
    async message(ws, message) {
      // send a compressed message
      ws.send("Hello world!", true);
    },
  },
});