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

Upgrade Bun to the latest version Detect when code is executed with Bun Get the current Bun version Hash a password Generate a UUID Encode and decode base64 data Compress and decompress data with gzip Compress and decompress data with DEFLATE Escape an HTML string Check if two objects are deeply equal Sleep for a fixed number of milliseconds Convert a file URL to an absolute path Convert an absolute path to a file URL Get the path to an executable bin file Get the directory of the current file Get the file name of the current file Get the absolute path of the current file Check if the current file is the entrypoint Get the absolute path to the current entrypoint

File SystemUtilities

Compress and decompress data with DEFLATE

Use Bun.deflateSync() to compress a Uint8Array with DEFLATE.

Compress and decompress data with gzip

Use Bun.gzipSync() to compress a Uint8Array with gzip.

Escape an HTML string

Bun.escapeHTML() escapes HTML characters in a string. It makes the following replacements.