Bun 已支持 Windows ! 了解在 Bun 1.1 中发生的新鲜事 →

重磅发布，Bun v1.1.34 在此! →

Bun 是一个快速的JavaScript
all-in-one toolkit|

开发、测试、运行、打包 JavaScript 或 TypeScript 项目如今都可以用 Bun 实现。Bun 是一个为速度而生的一站式 JavaScript 运行时，同时完全集成了打包器、测试套件和 Node.js 兼容的包管理器。

安装 Bun v1.1.34 如此简单

curl -fsSL https://bun.sh.cn/install | bash

$ bun run

Bun 是一个 JavaScript 运行时

Bun是一个从零开始构建的新JavaScript运行时环境，旨在服务于现代JavaScript生态系统。它有三个主要设计目标：

高速体验贯彻始终。 Bun启动快速，运行快速。它扩展了为Safari构建的性能导向的JavaScript引擎JavaScriptCore。快速启动时间意味着快速的应用程序和快速的API。
贴心集成尽显优雅。 Bun提供了一组最小化且高度优化的API，用于执行常见任务，例如启动HTTP服务器和写入文件。
开发过程扣人心弦。 Bun是一个完整的工具包，用于构建JavaScript应用程序，包括包管理器、测试运行器和打包工具。

Bun被设计为Node.js的即插即用替代品。它本身原生实现了数百个Node.js和Web API，包括 fs、path、Buffer等等。

Bun的目标是运行大部分全球的服务器端JavaScript，并提供工具来提高性能、减少复杂性并提高开发者的生产力。

Node.js 兼容性

Bun 的目标是成为 Node.js 的直接替代品。它实现了 Node 的模块解析算法、全局变量（比如Buffer 和 process）, 以及内建模块（比如fs 和 path）。点此跟踪 Bun 实现完全兼容性的进度。

飞快的运行性能

Bun 扩展了 JavaScriptCore 引擎（为 Safari 构建的注重性能的 JS 引擎），并在 Zig 中实现了本机速度功能。

继续与 node_modules 协同

使用 Bun，您仍然可以用 package.json 来管理您的依赖项。使用 Bun 的原生 npm 客户端来查看安装依赖项的速度有多快。

不再为“module”发狂

忘记有关 CommonJS、ESM、文件扩展名、解析优先级和 package.json 配置的复杂规则。Bun帮你都打理好了。

TypeScript

TypeScript 是 Bun 的一等公民。直接执行 .ts 和.tsx 文件。 Bun 尊重您在 tsconfig.json中的配置，包括 "paths"、 "jsx" 等。

Web 标准 API

Bun 实现了您熟悉和喜爱的 Web 标准 API，包括 fetch、 ReadableStream、 Request、 Response、 WebSocket、和FormData。

JSX

JSX 也在原生支持范畴。 Bun 在内部将 JSX 语法转换为普通 JavaScript。就和解释TypeScript一样，Bun 默认采用 React，但尊重您在tsconfig.json中的配置。

监视模式

我们的 bun run CLI提供了一个智能的 --watch 选项，使得当任何导入的文件发生更改时会自动重新启动进程。

你所需的API，Bun 尽已集成其中

启动一个HTTP服务器

启动一个WebSocket服务器

读取和写入文件

对密码执行Hash处理

为浏览器执行打包

编写一个测试用例

文件系统路由

读取一个Stream

执行一个shell脚本

调用一个C函数

index.tsx

              const server = Bun.serve({
  port: 3000,
  fetch(request) {
    return new Response("Welcome to Bun!");
  },
});

console.log(`Listening on localhost:${server.port}`);

index.tsx

              const server = Bun.serve<{ authToken: string; }>({
  fetch(req, server) {
    // use a library to parse cookies
    const cookies = parseCookies(req.headers.get("Cookie"));
    server.upgrade(req, {
      data: { authToken: cookies['X-Token'] },
    });
  },
  websocket: {
    // handler called when a message is received
    async message(ws, message) {
      console.log(`Received: ${message}`);
      const user = getUserFromToken(ws.data.authToken);
      await db.Message.insert({
        message: String(message),
        userId: user.id,
      });
    },
  },
});

console.log(`Listening on localhost:${server.port}`);
            

                
                
              
                
              
              
            

index.tsx

              const file = Bun.file(import.meta.dir + '/package.json'); // BunFile

const pkg = await file.json(); // BunFile extends Blob
pkg.name = 'my-package';
pkg.version = '1.0.0';

await Bun.write(file, JSON.stringify(pkg, null, 2));

index.tsx

              const password = "super-secure-pa$$word";

const hash = await Bun.password.hash(password);
// => $argon2id$v=19$m=65536,t=2,p=1$tFq+9AVr1bfPxQdh...

const isMatch = await Bun.password.verify(password, hash);
// => true

bundle.tsx

              await Bun.build({
  entrypoints: ["./index.tsx"],
  outdir: "./build",
  minify: true,
  plugins: [ /* ... */ ]
})

index.tsx

              import { describe, expect, test, beforeAll } from "bun:test";

beforeAll(() => {
  // setup tests
});

describe("math", () => {
  test("addition", () => {
    expect(2 + 2).toBe(4);
    expect(7 + 13).toMatchSnapshot();
  });
});

index.tsx

              const router = new Bun.FileSystemRouter({
  style: "nextjs",
  dir: "/path/to/pages"
});

const match = router.match("/blog/my-cool-post");
match.filePath; // "/path/to/pages/blog/[slug].tsx",
match.kind; // "dynamic"
match.params; // { slug: "my-cool-post" }

index.tsx

              const response = await fetch("https://bun.sh.cn");

await Bun.readableStreamToArrayBuffer(response.body); // => ArrayBuffer
await Bun.readableStreamToBlob(response.body); // => Blob
await Bun.readableStreamToJSON(response.body); // => object
await Bun.readableStreamToText(response.body); // => string
await Bun.readableStreamToArray(response.body); // => unknown[]

index.tsx

              import { $ } from 'bun';

// Run a cross-platform shell command
await $`echo "Hello, world!"`;

const response = await fetch("https://example.com");

// Pipe the response body to gzip
const data = await $`gzip < ${response}`.arrayBuffer();

index.tsx

              import { dlopen, FFIType, suffix } from "bun:ffi";

// `suffix` is either "dylib", "so", or "dll" depending on the platform
const path = `libsqlite3.${suffix}`;

const {
  symbols: {
    sqlite3_libversion, // the function to call
  },
} = dlopen(path, {
  sqlite3_libversion: {
    args: [], // no arguments
    returns: FFIType.cstring, // returns a string
  },
});

console.log(`SQLite 3 version: ${sqlite3_libversion()}`);

$ bun install

Bun 兼容 NPM，还更快，妙不可言

Bun

pnpm

17x slower

npm

29x slower

Yarn

33x slower

从 Remix 应用程序的缓存中安装依赖项。
查看基准测试

兼容 Node.js

Bun 仍然会将您的依赖项安装到 node_modules 比如 npm 这样包管理器或其他包管理器中 - 但他们速度快多了。即便您不使用 Bun 运行时，也可将 Bun 作为包管理器使用。

难以置信的快

Bun 使用每个操作系统上最快的系统调用，使安装速度比您想象的更快。

工作空间

工作空间（Workspaces）开箱即用。 Bun从您的 package.json 中读取workspaces 的键值，并为您的整个 monorepo 安装依赖项。

全局安装缓存

下载一次，随处安装。 Bun 只从 npm 下载特定版本的包一次；以后的安装将从缓存中复制它。

二进制lockfile

在依赖安装后，Bun 将创建一个二进制 bun.lockb 这样代表每个依赖项的已分析版本的lockfile（锁定文件）。二进制格式使得读取和解析速度比基于 JSON 或 Yaml 的lockfile快得多。

熟悉的API

Bun 的 CLI 使用的命令和选项对于 npm, pnpm, 或者 yarn 的任何用户来说都会感到熟悉。

立即替换您项目流程中的 yarn 变为 bun install 去感受30倍的包安装效率提升！

$ bun test

Bun 引领卓越测试体验，一骑绝尘

Bun

Vitest

5x slower

Jest+SWC

8x slower

Jest+tsjest

18x slower

Jest+Babel

20x slower

为 Zod项目运行测试套件
查看基准测试

兼容 Jest 的语法

Bun 提供了 Jest 风格的 expect() API。切换到 bun test 不用更改您原先的代码。

难以置信的快

Bun 的快速启动时间在测试运行程序中表现出色。您将难以想象你原先的测试用例将快多少。

生命周期hooks（钩子）

使用 beforeEach/afterEach 运行每个测试用例开始阶段和结束阶段的代码，或者使用 beforeAll/afterAll 运行每个文件开始阶段和结束阶段的代码。

快照测试

完全支持使用 .toMatchSnapshot() 进行持久化快照测试。使用 --update-snapshots 选项覆盖快照。

DOM APIs

使用 happy-dom 在测试中模拟 DOM 和浏览器 API。

监视模式

Bun的瞬时监视模式可以使用 --watch 选项使当文件发生变更时去重新运行测试用例。

函数模拟

用 mock() 模拟函数，或者用 spyOn() 监听方法执行。

立即替换您项目流程中的 jest 变为 bun test 去获得10-30倍的测试用例执行效率提升！

1

安装Bun

curl -fsSL https://bun.sh.cn/install | bash

2

编写代码

index.tsx

              const server = Bun.serve({
  port: 3000,
  fetch(request) {
    return new Response("Welcome to Bun!");
  },
});

console.log(`Listening on localhost:${server.port}`);

3

启动

bun index.tsx

从小例子开始您的 Bun 之旅

我们的指南详细介绍了如何使用 Bun 执行常见任务。

生态

使用 Vite 和 Bun 构建前端项目

运行时

为 Bun 安装 Typescript 声明

Streams（流）

使用 Bun 覆盖一个 ReadableStream

生态相关

使用 React 和 JSX

使用 EdgeDB 与 Bun

使用 Prisma 与 Bun

创建一个 Discord 机器人

使用 Drizzle ORM 与 Bun

使用 PM2 作为守护进程运行 Bun

使用 Nuxt 和 Bun 构建应用

使用 Qwik 和 Bun 构建应用

使用 Astro 和 Bun 构建应用

使用 Remix 和 Bun 构建应用

使用 systemd 作为守护进程运行 Bun

使用 Next.js 和 Bun 构建应用

使用 SvelteKit 和 Bun 构建应用

使用 Vite 和 Bun 构建前端

使用 SolidStart 和 Bun 构建应用

使用 Hono 和 Bun 构建 HTTP 服务器

使用 Elysia 和 Bun 构建 HTTP 服务器

使用 Docker 容器化 Bun 应用

使用 Express 和 Bun 构建 HTTP 服务器

服务器端渲染 (SSR) React 组件

使用 StricJS 和 Bun 构建 HTTP 服务器

使用 Mongoose 和 Bun 读取和写入 MongoDB 数据

HTTP相关

常见的 HTTP 服务器用法

热重载 HTTP 服务器

编写一个简单的 HTTP 服务器

在 HTTP 服务器上配置 TLS

使用 fetch 发送 HTTP 请求

作为 HTTP 响应流式传输文件

通过 HTTP 使用 FormData 上传文件

在 Bun 中使用 Unix 域套接字的 fetch

包管理相关

添加一个依赖

添加一个Git依赖

添加一个同级依赖

添加一个tarball依赖

添加一个可信依赖

添加一个可选依赖

添加一个开发依赖

使用bun install与Artifactory

生成一个可读的锁文件

使用工作区配置单一仓库

使用不同名称安装一个包

在GitHub Actions中使用Bun安装依赖

为bun install重写默认的npm注册表

使用Azure Artifacts npm注册表与bun install

为组织范围使用bun install配置私有注册表

进程处理相关

从标准输入读取

监听操作系统信号

生成子进程

解析命令行参数

从子进程读取标准错误输出

从子进程读取标准输出

获取进程运行时间（纳秒）

生成子进程并使用 IPC 通信

文件读取相关

读取一个 JSON 文件

检查文件是否存在

将文件读取到 Buffer

将文件读取为字符串

获取文件的 MIME 类型

将文件读取到 Uint8Array

将文件读取为 ArrayBuffer

监视目录变更

将文件读取为 ReadableStream

运行时相关

导入一个 JSON 文件

导入一个 TOML 文件

运行 Shell 命令

重新映射 import 路径

在 Bun 中设置时区

设置环境变量

读取环境变量

使用 web 调试器调试 Bun

在 GitHub Actions 中安装和运行 Bun

为 Bun 安装 TypeScript 声明

使用 VS Code 扩展调试 Bun

流处理相关

将 ReadableStream 转换为 JSON

将 ReadableStream 转换为 Blob

将 ReadableStream 转换为 Buffer

将 ReadableStream 转换为字符串

将 ReadableStream 转换为 Uint8Array

将 ReadableStream 转换为 ArrayBuffer

将 ReadableStream 转换为chunks（块）数组

测试相关

在 bun test 中模拟函数

在 bun test 中监视方法

在 bun test 中更新快照

使用 Bun 以监视模式运行测试

在 bun test 中使用快照测试

使用 Bun 测试运行器提前退出

使用 Bun 测试运行器跳过测试

从 Jest 迁移到 Bun 的测试运行器

使用 Bun 测试运行器运行你的测试

在 Bun 测试运行器中设置系统时间

使用 Bun 和 happy-dom 编写浏览器 DOM 测试

使用 Bun 测试运行器为每个测试设置超时

使用 Bun 测试运行器将测试标记为“待办”

使用 Bun 测试运行器多次重新运行测试

使用 Bun 测试运行器设置代码覆盖率阈值

使用 Bun 测试运行器生成代码覆盖率报告

实用业务场景

对密码进行哈希

转义 HTML 字符串

获取当前 Bun 版本

编码和解码 base64 字符串

检查两个对象是否深度相等

检测代码是否使用 Bun 执行

获取当前文件的目录

获取当前文件的文件名

将文件 URL 转换为绝对路径

使用 gzip 压缩和解压缩数据

将绝对路径转换为文件 URL

获取可执行二进制文件的路径

休眠固定数量的毫秒

使用 DEFLATE 压缩和解压缩数据

获取当前文件的绝对路径

检查当前文件是否为入口点

获取当前入口点的绝对路径

WebSocket相关

构建一个简单的 WebSocket 服务器

启用 WebSocket 消息的压缩

构建一个发布-订阅模式的 WebSocket 服务器

设置 WebSocket 的每个套接字上下文数据

写文件相关

删除一个文件

将 Blob 写入文件

将文件写入 stdout

向文件追加内容

将字符串写入文件

逐步写入文件

将 Response 写入文件

将文件复制到另一个位置

将 ReadableStream 写入文件