Get Started

Welcome to Bun Installation Quickstart TypeScript TypeScript 6 and 7

Watch Mode Debugging REPL bunfig.toml File Types Module Resolution JSX Auto-install Plugins File System Router

Cookies File I/O Streams Binary Data Archive SQL SQLite S3 Redis Workers Environment Variables Shell Spawn WebView Cron Node-API FFI C Compiler Transpiler CSRF Protection Secrets Console TOML YAML Markdown JSON5 JSONL HTMLRewriter Image Hashing Glob Semver Color Utils Globals Bun APIs Web APIs Node.js Compatibility

Build a simple WebSocket server Build a publish-subscribe WebSocket server Set per-socket contextual data on a WebSocket Enable compression for WebSocket messages

File SystemWebSocket

Enable compression for WebSocket messages

Set the perMessageDeflate parameter to compress all messages with the permessage-deflate WebSocket extension.

Set per-socket contextual data on a WebSocket

A WebSocket server typically needs to store some identifying information or context for each connected client.

Add a dependency

To add an npm package as a dependency, use bun add .