Bun 中文文档

Bun

Documentation   •   Discord   •   Issues   •   Roadmap

Read the docs →

什么是 Bun？

Bun 正在积极开发中。 使用它可以加速您的开发工作流程，或在资源受限的环境（如无服务器函数）中运行更简单的生产代码。我们正在努力实现更完整的 Node.js 兼容性，并与现有框架集成。加入Discord并关注GitHub 存储库以跟踪未来的发布。

Bun 是 JavaScript 和 TypeScript 应用程序的一站式工具包。它作为一个名为bun的单个可执行文件提供。

其核心是Bun 运行时，这是一个快速的 JavaScript 运行时，设计为 Node.js 的即插即用替代品。它是用 Zig 编写的，在底层由 JavaScriptCore 驱动，大大减少了启动时间和内存使用。

bun run index.tsx             # 默认支持TS和JSX

bun命令行工具还实现了测试运行器、脚本运行器和与 Node.js 兼容的包管理器。与开发需要 1,000 个 node_modules 不同，您只需要bun。Bun 的内置工具明显比现有选项快，并且在现有 Node.js 项目中几乎不需要进行任何更改。

bun test                      # 运行测试
bun run start                 # 运行`package.json`中的`start`脚本
bun install <pkg>             # 安装包
bunx cowsay 'Hello, world!'   # 执行包

安装

Bun 支持 Linux（x64 和 arm64）和 macOS（x64 和 Apple Silicon）。

Linux 用户 —— 强烈建议使用 5.6 或更高版本的内核，但最低版本为 5.1。

Windows 用户 —— Bun 目前不提供本机 Windows 版本。我们正在努力解决这个问题；进展可以在此问题上跟踪。在此期间，对于 Windows Subsystem for Linux，可以使用以下安装方法之一。

# 使用安装脚本（推荐）
curl -fsSL https://bun.sh/install | bash

# 使用npm
npm install -g bun

# 使用Homebrew
brew tap oven-sh/bun
brew install bun

# 使用Docker
docker pull oven/bun
docker run --rm --init --ulimit memlock=-1:-1 oven/bun

升级

要升级到 Bun 的最新版本，请运行：

bun upgrade

Bun 会在每次提交到main分支时自动发布一个 canary 版本。要升级到最新的 canary 版本，请运行：

bun upgrade --canary

查看 canary 版本

快速链接

• Intro

  • What is Bun

  • Installation

  • Quickstart

  • Typescript

  • Templates

• Runtime

  • bun run

  • File types

  • TypeScript

  • JSX

  • Environment variables

  • Bun APIs

  • Web APIs

  • Node.js compatibility

  • Plugins

  • Watch mode

  • Module resolution

  • Auto-install

  • bunfig.toml

  • Debugger

• Package manager

  • bun install

  • Global cache

  • Workspaces

  • Lockfile

  • Scopes and registries

  • Utilities

• Bundler

  • Bun.build

  • Loaders

  • Plugins

  • Executables

  • Macros

  • vs esbuild

• Test runner

  • bun test

  • Writing tests

  • Watch mode

  • Lifecycle hooks

  • Mocks

  • Snapshots

  • Dates and times

  • DOM testing

  • Code coverage

• Package runner

  • bunx

• API

  • HTTP server

  • WebSockets

  • Workers

  • Binary data

  • Streams

  • File I/O

  • import.meta

  • SQLite

  • FileSystemRouter

  • TCP sockets

  • Globals

  • Child processes

  • Transpiler

  • Hashing

  • Console

  • FFI

  • HTMLRewriter

  • Testing

  • Utils

  • Node-API

• Project

  • Roadmap
  • Benchmarking
  • Development
  • License