Bun

阅读文档 →

什么是 Bun？

Bun 是一款专为 JavaScript 和 TypeScript 应用打造的一体化工具包。它以名为 bun 的单个可执行文件形式提供。

其核心是 Bun 运行时，这是一种快速的 JavaScript 运行时，旨在作为 Node.js 的直接替代品。它由 Rust 编写，底层基于 JavaScriptCore，从而大幅降低了启动时间和内存占用。

bun run index.tsx             # TS and JSX supported out-of-the-box

bun 命令行工具还集成了测试运行器、脚本运行器以及兼容 Node.js 的包管理器。在开发过程中，您无需使用 1,000 个 node_modules，只需 bun 个即可。Bun 自带的工具比现有的同类工具快得多，且几乎无需修改即可用于现有的 Node.js 项目中。

bun test                      # run tests
bun run start                 # run the `start` script in `package.json`
bun install <pkg>             # install a package
bunx cowsay 'Hello, world!'   # execute a package

安装

Bun 支持 Linux（x64 及 arm64）、macOS（x64 及 Apple Silicon）以及 Windows（x64 及 arm64）系统。

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

x64 用户 — 如果出现“非法指令”或类似错误，请查看我们的 CPU 要求

# with install script (recommended)
curl -fsSL https://bun.com/install | bash

# on windows
powershell -c "irm bun.sh/install.ps1 | iex"

# with npm
npm install -g bun

# with Homebrew
brew tap oven-sh/bun
brew install bun

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

升级

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

bun upgrade

每当向 main 提交代码时，Bun 会自动发布一个测试版构建版本。要升级到最新的测试版构建，請运行：

bun upgrade --canary

查看测试版构建

快速链接

• 简介

  • 什么是 Bun？
  • 安装
  • 快速入门
  • TypeScript
  • TypeScript 6

• 模板功能

  • bun init
  • bun create

• 运行时相关

  • bun run
  • 文件类型（加载器）
  • JSX
  • 环境变量
  • Bun API
  • Web API
  • 与 Node.js 的兼容性
  • 插件
  • 监视模式/热重载
  • 模块解析
  • 自动安装
  • bunfig.toml
  • 调试器
  • REPL
  • $ Shell

• 包管理器

  • bun install
  • bun add
  • bun remove
  • bun update
  • bun link
  • bun pm
  • bun outdated
  • bun publish
  • bun patch
  • bun why
  • bun audit
  • bun info
  • 全局缓存
  • 全局存储
  • 隔离安装
  • 工作区
  • 目录
  • 生命周期脚本
  • 筛选
  • 锁定文件
  • 作用域与注册表
  • 覆盖与解析
  • 安全扫描器 API
  • .npmrc

• 打包工具

  • Bun.build
  • 加载器
  • 插件
  • 宏
  • vs esbuild
  • 单文件可执行文件
  • CSS
  • HTML 与静态站点
  • 热模块替换 (HMR)
  • 基于 HTML 导入的全栈开发
  • 独立 HTML 文件
  • 字节码缓存
  • 压缩工具

• 测试运行器

  • bun test
  • 编写测试用例
  • 生命周期钩子
  • 模拟对象
  • 快照
  • 日期与时间
  • DOM 测试
  • 代码覆盖率
  • 配置
  • 发现机制
  • 报告生成器
  • 运行时行为

• 包执行器

  • bunx

• API

  • HTTP 服务器 (Bun.serve)
  • HTTP 路由
  • HTTP 错误处理
  • HTTP 指标统计
  • WebSockets
  • 工作进程
  • 二进制数据
  • 流
  • 文件 I/O (Bun.file)
  • 归档 (tar)
  • SQLite (bun:sqlite)
  • PostgreSQL (Bun.sql)
  • Redis (Bun.redis)
  • S3 客户端 (Bun.s3)
  • 文件系统路由器
  • TCP 套接字
  • UDP 套接字
  • 全局变量
  • 子进程 (spawn)
  • Cron 定时任务 (Bun.cron)
  • WebView
  • 转译器 (Bun.Transpiler)
  • 哈希处理
  • 颜色处理 (Bun.color)
  • 控制台
  • FFI (bun:ffi)
  • C 编译器 (bun:ffi cc)
  • HTML 重写器
  • CookieBun.Cookie)
  • CSRF 防护 (Bun.CSRF)
  • 机密信息处理 (Bun.secrets)
  • YAML 格式Bun.YAML)
  • TOML 格式Bun.TOML)
  • JSON5
  • JSONL
  • Markdown
  • 图像处理
  • 实用工具
  • Node-API
  • Glob 模式 (Bun.Glob)
  • Semver 版本规范 (Bun.semver)
  • DNS 解析
  • fetch API 扩展功能

指南

• 部署

  • 部署到 Vercel
  • 部署到 Railway
  • 部署到 Render
  • 部署到 AWS Lambda
  • 部署到 DigitalOcean
  • 部署到 Google Cloud Run

• Binary

  • 将 Blob 转换为字符串
  • 将 Buffer 转换为 Blob
  • 将 Blob 转换为 DataView
  • 将 Buffer 转换为字符串
  • 将 Blob 转换为 ReadableStream
  • 将 Blob 转换为 Uint8Array
  • 将 DataView 转换为字符串
  • 将 Uint8Array 转换为 Blob
  • 将 Blob 转换为 ArrayBuffer
  • 将 ArrayBuffer 转换为 Blob
  • 将 Buffer 转换为 Uint8Array
  • 将 Uint8Array 转换为 Buffer
  • 将 Uint8Array 转换为字符串
  • 将 Buffer 转换为 ArrayBuffer
  • 将 ArrayBuffer 转换为 Buffer
  • 将 ArrayBuffer 转换为字符串
  • 将 Uint8Array 转换为 DataView
  • 将 Buffer 转换为 ReadableStream
  • 将 Uint8Array 转换为 ArrayBuffer
  • 将 ArrayBuffer 转换为 Uint8Array
  • 将 ArrayBuffer 转换为数字数组
  • 将 Uint8Array 转换为 ReadableStream

• Ecosystem

  • 使用 React 和 JSX
  • 在 Bun 中使用 Gel
  • 在 Bun 中使用 Prisma
  • 在 Bun 中使用 Prisma Postgres
  • 在 Bun 应用中添加 Sentry
  • 创建一个 Discord 机器人
  • 使用 PM2 将 Bun 作为守护进程运行
  • 在 Bun 中使用 Drizzle ORM
  • 在 Bun 中使用 Upstash Redis
  • 使用 Nuxt 和 Bun 构建应用
  • 使用 Qwik 和 Bun 构建应用
  • 使用 Astro 和 Bun 构建应用
  • 使用 Remix 和 Bun 构建应用
  • 使用 Vite 和 Bun 构建前端
  • 使用 Next.js 和 Bun 构建应用
  • 使用 systemd 将 Bun 作为守护进程运行
  • 使用 Hono 和 Bun 构建 HTTP 服务器
  • 使用 SvelteKit 和 Bun 构建应用
  • 使用 SolidStart 和 Bun 构建应用
  • 使用 TanStack Start 和 Bun 构建应用
  • 使用 Elysia 和 Bun 构建 HTTP 服务器
  • 使用 StricJS 和 Bun 构建 HTTP 服务器
  • 使用 Docker 将 Bun 应用容器化
  • 使用 Express 和 Bun 构建 HTTP 服务器
  • 通过 Drizzle ORM 使用 Neon Postgres
  • 对 React 组件进行服务器端渲染 (SSR)
  • 使用 Mongoose 和 Bun 读写 MongoDB 数据
  • 在 Bun 中使用 Neon 的 Serverless Postgres

• HTMLRewriter

  • 使用 HTMLRewriter 从网页中提取链接
  • 提取社交分享图片及 Open Graph 标签

• HTTP

  • 热重载 HTTP 服务器
  • 常见 HTTP 服务器用法
  • 编写简单的 HTTP 服务器
  • 在 HTTP 服务器上配置 TLS
  • 使用 fetch 发送 HTTP 请求
  • 使用 fetch() 代理 HTTP 请求
  • 启动一组 HTTP 服务器
  • 将文件作为 HTTP 响应流式传输
  • 在 Bun 中使用 Unix 域套接字进行 fetch 操作
  • 使用 FormData 通过 HTTP 上传文件
  • 使用异步迭代器实现流式 HTTP 服务器
  • 使用 Node.js Streams 实现流式 HTTP 服务器
  • 在 Bun 中使用服务器推送事件 (SSE)

• 安装

  • 添加依赖项
  • 添加 Git 依赖项
  • 添加同级依赖项
  • 添加受信任的依赖项
  • 添加开发依赖项
  • 添加 tarball 形式的依赖项
  • 添加可选依赖项
  • 生成兼容 yarn 的锁文件
  • 使用 workspaces 配置单仓库项目
  • 以不同名称安装包
  • 在 GitHub Actions 中使用 Bun 安装依赖项
  • 在 Artifactory 中使用 bun install 命令
  • 配置 git 以对比 Bun 的 lockfile 文件
  • 为 bun install 覆盖默认的 npm 仓库
  • 在 Azure Artifacts npm 仓库中使用 bun install 命令
  • 从 npm install 迁移为 bun install
  • 使用 bun install 为组织范围配置私有仓库

• 进程处理

  • 从标准输入读取数据
  • 监听 CTRL+C 信号
  • 启动子进程
  • 监听操作系统信号
  • 解析命令行参数
  • 从子进程读取标准错误输出
  • 从子进程读取标准输出
  • 以纳秒为单位获取进程运行时间
  • 启动子进程并通过 IPC 进行通信

• 读取文件

  • 读取 JSON 文件
  • 检查文件是否存在
  • 将文件作为字符串读取
  • 将文件读取到 Buffer 对象中
  • 获取文件的 MIME 类型
  • 监控目录中的文件变化
  • 将文件作为 ReadableStream 对象读取
  • 将文件读取到 Uint8Array 对象中
  • 将文件读取到 ArrayBuffer 对象中

• 运行时

  • 删除文件
  • 运行 Shell 命令
  • 导入 JSON 文件
  • 导入 TOML 文件
  • 导入 YAML 文件
  • 导入 JSON5 文件
  • 在 Bun 中设置时区
  • 设置环境变量
  • 重新映射导入路径
  • 删除目录
  • 读取环境变量
  • 将 HTML 文件作为文本导入
  • 在 GitHub Actions 中安装并运行 Bun
  • 使用网页调试器调试 Bun
  • 为 Bun 安装 TypeScript 声明文件
  • 使用 VS Code 扩展调试 Bun
  • 使用 V8 堆快照检查内存使用情况
  • 定义并替换静态全局变量与常量
  • 使用 --define 设置构建时常量
  • 在 macOS 上对单文件 JavaScript 可执行文件进行代码签名

• 流

  • 将 ReadableStream 转换为 JSON
  • 将 ReadableStream 转换为 Blob
  • 将 ReadableStream 转换为 Buffer
  • 将 ReadableStream 转换为字符串
  • 将 ReadableStream 转换为 Uint8Array
  • 将 ReadableStream 转换为数据块数组
  • 将 Node.js Readable 对象转换为 JSON
  • 将 ReadableStream 转换为 ArrayBuffer
  • 将 Node.js Readable 对象转换为 Blob
  • 将 Node.js Readable 对象转换为字符串
  • 将 Node.js Readable 对象转换为 Uint8Array
  • 将 Node.js Readable 对象转换为 ArrayBuffer

• 测试

  • 在 bun test中监视方法
  • 使用 Bun 测试运行器提前终止测试
  • 在 bun test中模拟函数
  • 使用 Bun 在监视模式下运行测试
  • 在 bun test中使用快照测试
  • 使用 Bun 测试运行器跳过测试
  • [在 Bun 中使用 Testing Library
  • 在 bun test中更新快照
  • 使用 Bun 测试运行器运行测试
  • 在 Bun 的测试运行器中设置系统时间
  • 使用 Bun 测试运行器为单个测试设置超时时间
  • 从 Jest 迁移到 Bun 的测试运行器
  • 使用 Bun 和 happy-dom 编写浏览器 DOM 测试
  • 使用 Bun 测试运行器将测试标记为“待办”
  • 使用 Bun 测试运行器多次重新运行测试
  • 使用 Bun 测试运行器生成代码覆盖率报告
  • 使用 bun test 导入、加载并测试 Svelte 组件
  • 使用 Bun 测试运行器设置代码覆盖率阈值
  • 使用通配符模式选择性地并发运行测试

• Util

  • 生成 UUID
  • 对密码进行哈希处理
  • 转义 HTML 字符串
  • 获取当前的 Bun 版本
  • 将 Bun 升级到最新版本
  • 对 base64 字符串进行编码与解码
  • 使用 gzip 对数据进行压缩与解压
  • 暂停指定毫秒数
  • 检测代码是否通过 Bun 执行
  • 检查两个对象是否深度相等
  • 使用 DEFLATE 对数据进行压缩与解压
  • 获取当前入口点的绝对路径
  • 获取当前文件的所在目录
  • 检查当前文件是否为入口点
  • 获取当前文件的文件名
  • 将文件 URL 转换为绝对路径
  • 将绝对路径转换为文件 URL
  • 获取当前文件的绝对路径
  • 获取可执行二进制文件的路径

• WebSocket

  • 构建发布-订阅型 WebSocket 服务器
  • 构建简单的 WebSocket 服务器
  • 为 WebSocket 消息启用压缩功能
  • 在 WebSocket 上设置每个套接字的上下文数据

• 写入文件

  • 删除文件
  • 写入标准输出
  • 将文件内容写入标准输出
  • 将 Blob 写入文件
  • 将字符串写入文件
  • 向文件追加内容
  • 分批写入文件
  • 将响应内容写入文件
  • 将文件复制到其他位置
  • 将 ReadableStream 写入文件

贡献代码

请参考 Project > Contributing 指南，开始为 Bun 贡献代码。

许可证

有关 Bun 许可证的详细信息，请查看 Project > License 页面。