type

WebSocketOptionsCompression

type WebSocketOptionsCompression =
  • perMessageDeflate?: boolean

    Whether to offer the permessage-deflate extension in the WebSocket upgrade request. Pass false to suppress the Sec-WebSocket-Extensions header entirely — matching the ws package's perMessageDeflate: false option.

    Defaults to true (the upgrade request advertises permessage-deflate; client_max_window_bits). Any falsy value (false, null, 0, "", explicit undefined) disables the offer.