Skip to main content

Bun

Menu

Home
GitHub(在新标签页打开)

Runtime › Get Started

Welcome to Bun
Installation
Quickstart
TypeScript
TypeScript 6 and 7
bun init
bun create

Runtime › Core Runtime

Bun Runtime
Watch Mode
Type checking
Debugging
REPL
bunfig.toml
Code generation from strings

Runtime › File & Module System

File Types
Module Resolution
JSX
Auto-install
Plugins
File System Router

Runtime › HTTP server

Server
Routing
Cookies
TLS
Error Handling
Metrics

Runtime › Networking

Fetch
WebSockets
TCP
UDP
DNS

Runtime › Data & Storage

Cookies
File I/O
Streams
Binary Data
Archive
SQL
SQLite
S3
Redis

Runtime › Concurrency

Workers
ModuleGraph

Runtime › Process & System

Environment Variables
Shell
Spawn
WebView
Cron

Runtime › Interop & Tooling

Node-API
FFI
C Compiler
Transpiler

Runtime › Utilities

CSRF Protection
Secrets
Console
TOML
YAML
Markdown
JSON5
XML
JSONL
HTMLRewriter
Image
Hashing
Glob
Semver
Color
Utils

Runtime › Standards & Compatibility

Globals
Bun APIs
Web APIs
Node.js Compatibility

Runtime › Contributing

Roadmap
Benchmarking
Contributing
Building Windows
Bindgen
License

Package Manager › Core Commands

bun install
bun add
bun remove
bun update
bun dedupe
bun prune
bunx

Package Manager › Publishing & Analysis

bun publish
bun outdated
bun why
bun audit
bun info

Package Manager › Workspace Management

Workspaces
Catalogs
bun link
bun pm

Package Manager › Advanced Configuration

bun patch
bun --filter
Global cache
Global virtual store
Isolated installs
Lockfile
Lifecycle scripts
Scopes and registries
Overrides and resolutions
Package extensions
Security Scanner API
.npmrc support

Bundler › Core

Bundler

Bundler › Development Server

Fullstack dev server
Hot reloading

Bundler › Asset Processing

HTML & static sites
Standalone HTML
CSS
Loaders

Bundler › Single File Executable

Single-file executable

Bundler › Extensions

Plugins
Macros

Bundler › Optimization

Bytecode Caching
Minifier

Bundler › Migration

esbuild

Test Runner › Getting Started

Test runner
Writing tests
Test configuration

Test Runner › Test Execution

Runtime behavior
Finding tests
Parallel & isolated test runs

Test Runner › Test Features

Lifecycle hooks
Mocks
Snapshots
Dates and times

Test Runner › Specialized Testing

DOM testing

Test Runner › Reporting

Code coverage
Test Reporters

Linter › Getting Started

Linter

Linter › Rules

Lint rules
ESLint plugins

Linter › Migrate

Migrate from ESLint
Migrate from oxlint

Formatter › Getting Started

Formatter

Formatter › Migrate

Migrate from Prettier
Migrate from oxfmt

Guides › Overview

Guides

Guides › Deployment

Deploy on Vercel
Deploy on Railway
Deploy on Render
Deploy on AWS Lambda
Deploy on DigitalOcean
Deploy on Google Cloud Run

Guides › Runtime & Debugging

TypeScript types
Re-map import paths
VS Code debugger
Web debugger
Heap snapshots
Build-time constants
Define constants
GitHub Actions
Codesign on macOS

Guides › Utilities

Upgrade Bun
Detect Bun
Get Bun version
Hash password
Generate UUID
Base64 encoding
Gzip compression
DEFLATE compression
Escape HTML
Deep equality
Sleep
File URL to path
Path to file URL
Find executable path
import.meta.dir
import.meta.file
import.meta.path
Check entrypoint
Get entrypoint path

Guides › Ecosystem & Frameworks

Astro with Bun
Discord.js with Bun
Docker with Bun
Drizzle with Bun
Gel with Bun
Elysia with Bun
Express with Bun
Hono with Bun
Mongoose with Bun
Neon Drizzle with Bun
Neon Serverless Postgres with Bun
Next.js with Bun
Nuxt with Bun
PM2 with Bun
Prisma ORM with Bun
Prisma Postgres with Bun
Qwik with Bun
React with Bun
Remix with Bun
TanStack Start with Bun
Sentry with Bun
SolidStart with Bun
SSR React with Bun
SvelteKit with Bun
systemd with Bun
Vite with Bun
Upstash with Bun

Guides › HTTP & Networking

HTTP Server with Bun
Simple HTTP Server with Bun
Fetch with Bun
Hot reload an HTTP server
Start a cluster of HTTP servers
Configure TLS
Proxy HTTP requests using fetch()
Stream file response
Upload files via HTTP using FormData
Fetch with unix domain sockets
Stream with iterators
Server-Sent Events
Stream with Node.js

Guides › WebSocket

Simple server
Pub-sub server
Contextual data
Enable compression

Guides › Processes & System

Spawn child process
Read stdout
Read stderr
Parse command-line arguments
Read from stdin
Spawn a child process and communicate using IPC
Listen for CTRL+C
OS signals
Process uptime
Run shell command
Set time zone
Set env variables
Read env variables

Guides › Package Manager

Add a dependency
Add a dev dependency
Add an optional dependency
Add a peer dependency
Add a Git dependency
Add a tarball dependency
Install with alias
Workspaces with Bun
Override the default npm registry
Configure a scoped registry
Azure Artifacts with Bun
JFrog Artifactory with Bun
Add a trusted dependency
Generate a yarn-compatible lockfile
Migrate from npm to bun
Configure git to diff Bun's lockfile
Install Bun in GitHub Actions

Guides › Test Runner

Run tests
Watch mode
Migrate from Jest
Mock functions
Spy on methods
Mock system time
Snapshot testing
Update snapshots
Coverage reports
Coverage threshold
Concurrent test glob
Skip tests
Todo tests
Test timeout
Bail early
Re-run tests
Testing Library
DOM tests
Test Svelte

Guides › Linter & Formatter

Migrate from ESLint
Migrate from oxlint
Migrate from Prettier
Migrate from oxfmt

Guides › Runtime & Debugging

VS Code debugger
Web debugger
Heap snapshots
Build-time constants
Define constants
GitHub Actions
Codesign on macOS

Guides › Module System

Import JSON
Import TOML
Import YAML
Import JSON5
Import XML
Import HTML
import.meta.dir
import.meta.file
import.meta.path
Check entrypoint
Get entrypoint path

Guides › File System

Read as string
Read to Buffer
Read to Uint8Array
Read to ArrayBuffer
Read JSON file
Get MIME type
Check file exists
Watch directory
Read as stream
Write string to file
Write Blob
Write Response
Append to file
Incremental write
Write stream
Write to stdout
Write file to stdout
Copy file
Delete file
Delete files
Delete directories

Guides › Utilities

Hash password
Generate UUID
Base64 encoding
Gzip compression
DEFLATE compression
Escape HTML
Deep equality
Sleep
File URL to path
Path to file URL
Find executable path

Guides › HTML Processing

Extract links using HTMLRewriter
OpenGraph tags

Guides › Binary Data

ArrayBuffer to string
ArrayBuffer to Buffer
ArrayBuffer to Blob
ArrayBuffer to Array
ArrayBuffer to Uint8Array
Buffer to string
Buffer to ArrayBuffer
Buffer to Blob
Buffer to Uint8Array
Buffer to ReadableStream
Blob to string
Blob to ArrayBuffer
Blob to Uint8Array
Blob to DataView
Blob to ReadableStream
Uint8Array to string
Uint8Array to ArrayBuffer
Uint8Array to Buffer
Uint8Array to Blob
Uint8Array to DataView
Uint8Array to ReadableStream
DataView to string

Guides › Streams

Stream to string
Stream to JSON
Stream to Blob
Stream to Buffer
Stream to ArrayBuffer
Stream to Uint8Array
Stream to array
Readable to string
Readable to JSON
Readable to Blob
Readable to Uint8Array
Readable to ArrayBuffer

Feedback

Feedback

Bun 简体中文

Bun

加宽正文