bun

The Bun shell is a powerful tool for running shell commands.

Allocate a new Uint8Array without zeroing the bytes.

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

Converts formats of colors

Concatenate an array of typed arrays into a single ArrayBuffer.

Create a TCP client that connects to a server via a TCP socket

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 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

Show precise statistics about memory usage of your application

Decompresses a chunk of data with zlib GUNZIP algorithm.

Compresses a chunk of data with zlib GZIP algorithm.

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

Decompresses a chunk of data with zlib INFLATE algorithm.

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

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.

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, which is a name-based UUID based on the SHA-1 hash of a namespace UUID and a name.

Generate a UUIDv7, which is 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.

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 provides a high-performance HTTP server with built-in routing support.

Hash input using SHA-2 512/256

Resolve a Promise after milliseconds.

Sleep the thread for a given number of milliseconds

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

Spawn a new process

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, similar to typing which 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.

A class for creating and extracting tar archives with optional gzip compression.

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

A class for working with a single cookie

A Map-like interface for working with collections 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.

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

Main SQL client interface providing connection and transaction management

A pseudo-terminal (PTY) that can be used to spawn 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 build artifact represents a file that was generated by the bundler

Metafile structure containing build metadata for analysis.

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.

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

Used when importing an HTML file at runtime or at build time.

Fast incremental writer for files and pipes.

The builder object passed to Bun.plugin

Represents a reserved connection from the connection pool Extends SQL with additional release functionality

Represents a file in an S3-compatible storage service.

Options for generating presigned URLs

Configuration options for S3 operations

Represents a savepoint within a transaction

HTTP & HTTPS Server

A fast WebSocket designed for servers.

Represents a TCP or TLS socket connection used for network communication.

Represents a SQL array parameter

A process created by Bun.spawn.

A process created by Bun.spawnSync.

Represents a TCP or TLS socket connection used for network communication.

Options for creating a pseudo-terminal (PTY).

Options for TLS connections

Represents a TCP or TLS socket connection used for network communication.

Represents a client within a transaction context Extends SQL with savepoint functionality

tsconfig.json options supported by Bun

Create a server-side ServerWebSocket handler for use with 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.

Types for 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.

The event names for the dev server

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

This lets you 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

A state that represents if a WebSocket is connected.

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

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

A list of files embedded into the standalone executable.

Are ANSI colors enabled for stdin and stdout?

The environment variables of the process

Hash a string or array buffer using Wyhash

Is the current global scope the main thread?

What script 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.

SQL client

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

bun install security related declarations

Bun.semver provides a fast way to parse and compare version numbers.

TOML related APIs

YAML related APIs