Bun API
Bun 全局对象和内置模块中可用的 Bun 原生 API 概述
Bun 在 Bun 全局对象上以及通过多个内置模块实现了一组原生 API。这些 API 经过高度优化，是实现常见功能时采用的标准“Bun 原生”方式。
Bun 力求尽可能实现标准 Web API。Bun 主要为服务器端任务引入新的 API，例如文件 I/O 和启动 HTTP 服务器等标准中尚不存在的任务。在此类情况下，Bun 的方法依然构建于诸如 Blob、URL 和 Request 等标准 API 之上。
server.tsBun.serve({
fetch(req: Request) {
return new Response("成功！");
},
});
使用表格中的链接跳转到相应的文档。
| 主题 | API |
|---|---|
| HTTP 服务器 | Bun.serve |
| Shell | $ |
| 打包器 | Bun.build |
| 文件 I/O | Bun.file, Bun.write, Bun.stdin, Bun.stdout, Bun.stderr |
| 子进程 | Bun.spawn, Bun.spawnSync |
| TCP 套接字 | Bun.listen, Bun.connect |
| UDP 套接字 | Bun.udpSocket |
| WebSocket | new WebSocket()（客户端），Bun.serve（服务器） |
| 转译器 | Bun.Transpiler |
| 路由 | Bun.FileSystemRouter |
| 流式 HTML | HTMLRewriter |
| 无头浏览器 | Bun.WebView |
| 哈希 | Bun.password, Bun.hash, Bun.CryptoHasher, Bun.sha |
| CSRF 防护 | Bun.CSRF.generate, Bun.CSRF.verify |
| SQLite | bun:sqlite |
| SQL 客户端 | Bun.SQL, Bun.sql |
| Redis（Valkey）客户端 | Bun.RedisClient, Bun.redis |
| FFI（外部函数接口） | bun:ffi |
| DNS | Bun.dns.lookup, Bun.dns.prefetch, Bun.dns.getCacheStats |
| 测试 | bun:test |
| 工作线程 | new Worker() |
| 模块加载器 | Bun.plugin |
| Glob（文件匹配） | Bun.Glob |
| Cookie | Bun.Cookie, Bun.CookieMap |
| Node-API | Node-API |
import.meta | import.meta |
| 实用工具 | Bun.version, Bun.revision, Bun.env, Bun.main |
| 睡眠与计时 | Bun.sleep(), Bun.sleepSync(), Bun.nanoseconds() |
| 随机数与 UUID | Bun.randomUUIDv7() |
| 系统与环境 | Bun.which() |
| 比较与检查 | Bun.peek(), Bun.deepEquals(), Bun.deepMatch, Bun.inspect() |
| 字符串与文本处理 | Bun.escapeHTML(), Bun.stringWidth(), Bun.indexOfLine |
| URL 与路径工具 | Bun.fileURLToPath(), Bun.pathToFileURL() |
| 压缩 | Bun.gzipSync(), Bun.gunzipSync(), Bun.deflateSync(), Bun.inflateSync(), Bun.zstdCompressSync(), Bun.zstdDecompressSync(), Bun.zstdCompress(), Bun.zstdDecompress() |
| 流处理 | Bun.readableStreamTo*(), Bun.readableStreamToBytes(), Bun.readableStreamToBlob(), Bun.readableStreamToFormData(), Bun.readableStreamToJSON(), Bun.readableStreamToArray() |
| 内存与缓冲区管理 | Bun.ArrayBufferSink, Bun.allocUnsafe, Bun.concatArrayBuffers |
| 模块解析 | Bun.resolveSync() |
| 解析与格式化 | Bun.semver, Bun.TOML.parse, Bun.XML, Bun.markdown, Bun.color, Bun.Image |
| 底层／内部实现 | Bun.mmap, Bun.gc, Bun.generateHeapSnapshot, bun:jsc |