Runtime
Bundler
Package Manager
Test Runner
Guides
Reference
Blog
Install Bun
Guides WebSocket

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.

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

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

server.ts
Bun.serve({
  // ...
  websocket: {
    async message(ws, message) {
      // send a compressed message
      ws.send(message, true);
    },
  },
});

On this page

No Headings