property perMessageDeflate | Bun module | Bun
BuildDocsReferenceGuidesBlogDiscord/
Bun/
WebSocketOptionsCompression/
perMessageDeflatePperMessageDeflate
Search the reference...
/
BuildDocsReferenceGuidesBlogDiscord/
Bun/
WebSocketOptionsCompression/
perMessageDeflatePperMessageDeflate
property
WebSocketOptionsCompression.perMessageDeflateperMessageDeflate?: 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.
Resources
ReferenceDocsGuidesDiscordMerch StoreGitHubBlog Toolkit
RuntimePackage managerTest runnerBundlerPackage runnerProject
Bun 1.0Bun 1.1Bun 1.2Bun 1.3RoadmapContributingLicenseBaked with ❤️ in San Francisco
We're hiring →