Bun

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

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

bun upgrade --canary

查看 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
  • 加载器
  • 插件
  • 宏
  • 与 esbuild 对比
  • CSS
  • HTML 和静态网站
  • 热模块替换（HMR）
  • 使用 HTML 导入构建全栈应用
  • 独立 HTML
  • 压缩器

• 编译器

  • 单文件可执行程序
  • 字节码缓存

• 测试运行器

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

• 包运行器

  • bunx

• API

  • HTTP 服务端（Bun.serve）
  • HTTP 路由
  • HTTP 错误处理
  • HTTP 指标
  • WebSockets
  • Workers
  • 二进制数据
  • 流
  • 文件 I/O（Bun.file）
  • 归档（tar）
  • SQLite（bun:sqlite）
  • PostgreSQL（Bun.sql）
  • Redis（Bun.redis）
  • S3 客户端（Bun.s3）
  • FileSystemRouter
  • TCP 套接字
  • UDP 套接字
  • 全局对象
  • 子进程（spawn）
  • Cron（Bun.cron）
  • WebView
  • 转译器（Bun.Transpiler）
  • 哈希
  • 颜色（Bun.color）
  • 控制台
  • FFI（bun:ffi）
  • C 编译器（bun:ffi cc）
  • HTMLRewriter
  • Cookie（Bun.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

• 二进制

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

• 生态系统

  • 使用 React 和 JSX
  • 在 Bun 中使用 Gel
  • 在 Bun 中使用 Prisma
  • 在 Bun 中使用 Prisma Postgres
  • 将 Sentry 添加到 Bun 应用
  • 创建 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's 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 配置 monorepo
  • 以不同名称安装包
  • 在 GitHub Actions 中使用 Bun 安装依赖项
  • 使用 bun install 和 Artifactory
  • 配置 git 以比较 Bun 的 lockb 锁文件
  • 为 bun install 覆盖默认 npm 注册表
  • 使用 bun install 和 Azure Artifacts npm 注册表
  • 从 npm install 迁移到 bun install
  • 使用 bun install 为组织作用域配置私有注册表

• 进程

  • 从 stdin 读取
  • 监听 CTRL+C
  • 生成子进程
  • 监听操作系统信号
  • 解析命令行参数
  • 读取子进程的 stderr
  • 读取子进程的 stdout
  • 获取进程运行时间（纳秒）
  • 生成子进程并使用 IPC 通信

• 读取文件

  • 读取 JSON 文件
  • 检查文件是否存在
  • 将文件读取为字符串
  • 将文件读取到 Buffer
  • 获取文件的 MIME 类型
  • 监视目录更改
  • 将文件读取为 ReadableStream
  • 将文件读取到 Uint8Array
  • 将文件读取到 ArrayBuffer

• 运行时

  • 删除文件
  • 运行 Shell 命令
  • 导入 JSON 文件
  • 导入 TOML 文件
  • 导入 YAML 文件
  • 导入 JSON5 文件
  • 在 Bun 中设置时区
  • 设置环境变量
  • 重新映射导入路径
  • 删除目录
  • 读取环境变量
  • 将 HTML 文件作为文本导入
  • 在 GitHub Actions 中安装并运行 Bun
  • 使用 Web 调试器调试 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 测试运行器将测试标记为“todo”
  • 使用 Bun 测试运行器多次重新运行测试
  • 使用 Bun 测试运行器生成代码覆盖率报告
  • 使用 bun test 导入、要求并测试 Svelte 组件
  • 使用 Bun 测试运行器设置代码覆盖率阈值
  • 使用 glob 模式有选择地并发运行测试

• 工具

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

• WebSocket

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

• 写入文件

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

参与贡献

请参阅项目 > 参与贡献指南，开始为 Bun 做贡献。

许可证

请参阅项目 > 许可证页面，了解 Bun 的许可信息。