bun

Runs a shell command with the Bun Shell.

Allocate a new Uint8Array without zeroing the bytes.

Bundles JavaScript, TypeScript, CSS, HTML and other supported files into optimized outputs.

Converts a color to a different format

Concatenate an array of typed arrays into a single ArrayBuffer.

Create a TCP client that connects to a server

Fast deep-equality check two objects.

Returns true if all properties in the subset exist in the other and have equal values.

Compresses a chunk of data with the zlib DEFLATE algorithm.

Escape the following characters in a string.

Blob powered by the fastest system calls available for operating on files.

Convert a URL to a filesystem path.

Manually trigger the garbage collector

Generates a heap snapshot in JavaScriptCore's format.

Decompresses a chunk of data with the zlib GUNZIP algorithm.

Compresses a chunk of data with the zlib GZIP algorithm.

Find the index of a newline character in potentially ill-formed UTF-8 text.

Decompresses a chunk of data with the zlib INFLATE algorithm.

Pretty-prints an object to a string, the same as console.log

Create a TCP server that listens on a port

Open a file as a live-updating Uint8Array without copying memory

Returns the number of nanoseconds since the process was started, measured with a high-resolution monotonic system timer.

Open a file in your local editor.

Convert a filesystem path to a file:// URL.

Extract the value from the Promise in the same tick of the event loop

Generate a UUIDv5, a name-based UUID derived from the SHA-1 hash of a namespace UUID and a name.

Generate a UUIDv7, a sequential ID based on the current timestamp with a random component.

Consume all data from a ReadableStream until it closes or errors.

Consume all data from a ReadableStream until it closes or errors, concatenating the chunks into a single ArrayBuffer.

Consume all data from a ReadableStream until it closes or errors.

Resolve a moduleId as though it were imported from parent

Synchronously resolve a moduleId as though it were imported from parent

Bun.serve starts a high-performance HTTP server with built-in routing.

Hash input using SHA-2 512/256

Returns a Promise that resolves after the given number of milliseconds, or at the given Date.

Block the thread for a given number of milliseconds.

Slice a string by visible column width, preserving ANSI escape codes.

Spawn a new process

Synchronously spawn a new process

Get the column count of a string as it would be displayed in a terminal.

Remove ANSI escape codes from a string.

Create a UDP socket

Find the path to an executable, like the which command in your terminal.

Wrap a string to fit within the specified column width, preserving ANSI escape codes.

Use the fastest syscalls available to copy from input into destination.

Compresses a chunk of data with the Zstandard (zstd) compression algorithm.

Compresses a chunk of data with the Zstandard (zstd) compression algorithm.

Decompresses a chunk of data with the Zstandard (zstd) decompression algorithm.

Decompresses a chunk of data with the Zstandard (zstd) decompression algorithm.

Create and extract tar archives, with optional gzip compression.

Fast incremental writer that becomes an ArrayBuffer on end().

A single HTTP cookie: its name, value, and attributes.

A Map-like collection of cookies.

Hardware-accelerated cryptographic hash functions

This class only exists in types

EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.

Resolve routes against a directory of files using Next.js-style (pages directory) conventions.

Match files using glob patterns).

Decode, transform and re-encode images.

This class only exists in types

This class only exists in types

A configured S3 bucket instance for managing files.

This is not the default because it's not cryptographically secure and it's slower than SHA512

This class only exists in types

This class only exists in types

This class only exists in types

This class only exists in types

See also sha

SQL client.

A pseudo-terminal (PTY) for spawning interactive terminal programs.

Quickly transpile TypeScript, JSX, or JS to modern JavaScript.

A WebSocket client implementation

A headless browser view for automation.

EventTarget is a DOM interface implemented by objects that can receive events and may have listeners for them.

Options for extracting archive contents.

Options for creating an Archive instance.

A file generated by the bundler.

Build metadata: every input and output file, its size, and the imports between them.

The output of a build

Blob powered by the fastest system calls available for operating on files.

Options for Bun.inspect

A message received by a target object.

A Bun plugin.

Extend Bun's module resolution and loading behavior

This Fetch API interface represents a resource request.

Controller object passed to the scheduled() handler when a cron job fires.

A handle to an in-process cron job returned by Bun.cron when called with a callback.

Options for the in-process Bun.cron callback overload and Bun.cron.parse.

An event which takes place in the DOM.

Blob powered by the fastest system calls available for operating on files.

Fast incremental writer for files and pipes.

JavaScriptCore engine's internal heap snapshot format

The result of importing an HTML file, at runtime or at build time.

Fast incremental writer for files and pipes.

The builder object passed to Bun.plugin

A connection reserved from the pool with SQL.reserve.

Represents a file in an S3-compatible storage service.

Options for generating presigned URLs

Configuration options for S3 operations

The client passed to TransactionSQL.savepoint callbacks; queries run within that savepoint

HTTP & HTTPS Server

A fast WebSocket designed for servers.

A TCP or TLS socket connection.

An array parameter created by SQL.array

A process created by Bun.spawn.

A process created by Bun.spawnSync.

An Error from a failed system call, with optional errno, code,

A TCP or TLS socket connection.

Options for creating a pseudo-terminal (PTY).

Options for TLS connections

A TCP or TLS socket connection.

The client passed to transaction callbacks (SQL.begin,

tsconfig.json options supported by Bun

Server-side ServerWebSocket event handlers for Bun.serve

Bun's Web Worker constructor supports some extra options on top of the API browsers have.

Compression options for Bun.deflateSync and Bun.gzipSync

Compression format for archive output.

Input data for creating an archive.

The structure of Bun's lockfile, bun.lock

Valid inputs for color

Extends the standard web formats with brotli and zstd support.

A cron schedule: a 5-field expression (minute hour day month weekday) or a nickname.

Event names accepted by import.meta.hot.on() and import.meta.hot.off()

https://bun.com/docs/bundler/loaders

Use macros as regular imports.

Utility type for any process from () with stdin, stdout, stderr all set to null or similar.

Utility type for any process from () with both stdout and stderr set to null or similar

Utility type for any process from () with stdin, stdout, stderr all set to "pipe".

Utility type for any process from () with both stdout and stderr set to "pipe"

Utility type for any process from () with both stdout and stderr set to "pipe"

A status that represents the outcome of a sent message.

Compression options for WebSocket messages.

Constructor options for the Bun.WebSocket client

The connection state of a WebSocket.

Utility type for any process from () with stdin set to "pipe"

The raw arguments passed to the process, including flags passed to Bun.

Schedule cron jobs.

A list of files embedded into the standalone executable, lexicographically sorted by name.

Whether ANSI colors are enabled for stdin and stdout

The environment variables of the process

Hash a string or array buffer using Wyhash

Whether the current global scope is the main thread

true when the current process is a standalone executable produced by

Absolute path of the script that launched Bun

Hash and verify passwords using argon2 or bcrypt.

Default Redis client

The git sha at the time the currently-running version of Bun was compiled

A default instance of S3Client

Securely store and retrieve sensitive credentials using the operating system's native credential storage.

The default SQL client, configured from environment variables such as

Write to stderr

Read from stdin

Write to stdout

The current version of Bun

The current version of Bun with the shortened commit sha of the build

Generate and verify CSRF tokens

DNS-related APIs

JSON5 related APIs

JSONC related APIs

JSONL (JSON Lines) related APIs.

Markdown related APIs.

Hash and verify passwords using argon2 or bcrypt

Security scanner declarations for bun install

Bun.semver parses and compares version numbers.

TOML related APIs

XML related APIs

YAML related APIs