Guides Overview

Guides

A collection of code samples and walkthroughs for performing common tasks with Bun.

A collection of code samples and walkthroughs for performing common tasks with Bun.

Featured

Use Tanstack Start with Bun

Use Next.js with Bun

Build a frontend using Vite and Bun

Install TypeScript declarations for Bun

Write a simple HTTP server

Build a simple WebSocket server

All Guides

Deployment

Deploy a Bun application on AWS Lambda

Deploy a Bun application on DigitalOcean

Deploy a Bun application on Google Cloud Run

Deploy a Bun application on Railway

Deploy a Bun application on Render

Deploy a Bun application on Vercel

Binary Data

Ecosystem & Frameworks

Add Sentry to a Bun app

Build a frontend using Vite and Bun

Build a React app with Bun

Build an app with Astro and Bun

Build an app with Next.js and Bun

Build an app with Nuxt and Bun

Build an app with Qwik and Bun

Build an app with Remix and Bun

Build an app with SolidStart and Bun

Build an app with SvelteKit and Bun

Build an HTTP server using Elysia and Bun

Build an HTTP server using Express and Bun

Build an HTTP server using Hono and Bun

Build an HTTP server using StricJS and Bun

Bun Redis with Upstash

Containerize a Bun application with Docker

Create a Discord bot

Read and write data to MongoDB using Mongoose and Bun

Run Bun as a daemon with PM2

Run Bun as a daemon with systemd

Server-side render (SSR) a React component

Use Drizzle ORM with Bun

Use Gel with Bun

Use Neon Postgres through Drizzle ORM

Use Neon's Serverless Postgres with Bun

Use Prisma Postgres with Bun

Use Prisma with Bun

Use TanStack Start with Bun

File System - Read

Check if a file exists

Get the MIME type of a file

Read a file as a ReadableStream

Read a file as a string

Read a file to a Buffer

Read a file to a Uint8Array

Read a file to an ArrayBuffer

Read a JSON file

Watch a directory for changes

File System - Write

Append content to a file

Copy a file to another location

Delete a file

Write a Blob to a file

Write a file incrementally

Write a file to stdout

Write a ReadableStream to a file

Write a Response to a file

Write a string to a file

Write to stdout

HTML Processing

Extract links from a webpage using HTMLRewriter

Extract social share images and Open Graph tags

HTTP & Networking

Common HTTP server usage

Configure TLS on an HTTP server

fetch with unix domain sockets in Bun

Hot reload an HTTP server

Proxy HTTP requests using fetch()

Send an HTTP request using fetch

Start a cluster of HTTP servers

Stream a file as an HTTP Response

Streaming HTTP Server with Async Iterators

Streaming HTTP Server with Node.js Streams

Upload files via HTTP using FormData

Write a simple HTTP server

Package Manager

Add a dependency

Add a development dependency

Add a Git dependency

Add a peer dependency

Add a tarball dependency

Add a trusted dependency

Add an optional dependency

Configure a private registry for an organization scope with bun install

Configure git to diff Bun's lockb lockfile

Configuring a monorepo using workspaces

Generate a yarn-compatible lockfile

Install a package under a different name

Install dependencies with Bun in GitHub Actions

Migrate from npm install to bun install

Override the default npm registry for bun install

Using bun install with an Azure Artifacts npm registry

Using bun install with Artifactory

Process & System

Get the process uptime in nanoseconds

Listen for CTRL+C

Listen to OS signals

Parse command-line arguments

Read from stdin

Read stderr from a child process

Read stdout from a child process

Spawn a child process

Spawn a child process and communicate using IPC

Runtime & Debugging

Build-time constants with --define

Codesign a single-file JavaScript executable on macOS

Debugging Bun with the VS Code extension

Debugging Bun with the web debugger

Define and replace static globals & constants

Delete directories

Delete files

Import a HTML file as text

Import a JSON file

Import a TOML file

Import a YAML file

Inspect memory usage using V8 heap snapshots

Install and run Bun in GitHub Actions

Install TypeScript declarations for Bun

Re-map import paths

Read environment variables

Run a Shell Command

Set a time zone in Bun

Set environment variables

Streams

Convert a Node.js Readable to a Blob

Convert a Node.js Readable to a string

Convert a Node.js Readable to an ArrayBuffer

Convert a Node.js Readable to an Uint8Array

Convert a Node.js Readable to JSON

Convert a ReadableStream to a Blob

Convert a ReadableStream to a Buffer

Convert a ReadableStream to a string

Convert a ReadableStream to a Uint8Array

Convert a ReadableStream to an array of chunks

Convert a ReadableStream to an ArrayBuffer

Convert a ReadableStream to JSON

Test Runner

Bail early with the Bun test runner

Generate code coverage reports with the Bun test runner

import, require, and test Svelte components with bun test

Mark a test as a "todo" with the Bun test runner

Migrate from Jest to Bun's test runner

Mock functions in `bun test`

Re-run tests multiple times with the Bun test runner

Run tests in watch mode with Bun

Run your tests with the Bun test runner

Selectively run tests concurrently with glob patterns

Set a code coverage threshold with the Bun test runner

Set a per-test timeout with the Bun test runner

Set the system time in Bun's test runner

Skip tests with the Bun test runner

Spy on methods in `bun test`

Update snapshots in `bun test`

Use snapshot testing in `bun test`

Using Testing Library with Bun

Write browser DOM tests with Bun and happy-dom

Utilities

Check if the current file is the entrypoint

Check if two objects are deeply equal

Compress and decompress data with DEFLATE

Compress and decompress data with gzip

Convert a file URL to an absolute path

Convert an absolute path to a file URL

Detect when code is executed with Bun

Encode and decode base64 strings

Escape an HTML string

Generate a UUID

Get the absolute path of the current file

Get the absolute path to the current entrypoint

Get the current Bun version

Get the directory of the current file

Get the file name of the current file

Get the path to an executable bin file

Hash a password

Sleep for a fixed number of milliseconds

Upgrade Bun to the latest version

WebSocket

Build a publish-subscribe WebSocket server

Build a simple WebSocket server

Enable compression for WebSocket messages

Set per-socket contextual data on a WebSocket

Deploy on AWS Lambda

Next Page

On this page

Ecosystem & Frameworks

File System - Read

File System - Write

HTML Processing

HTTP & Networking

Package Manager

Process & System

Runtime & Debugging