Skip to content

TypeScript

为了安装 Bun 内置 API 的 TypeScript 定义,请安装 @types/bun

sh
bun add -d @types/bun # 开发依赖

此时,你应该能够在你的 TypeScript 文件中引用全局 Bun 对象,并且在编辑器中不会看到错误。

ts
console.log(Bun.version);

推荐的 compilerOptions

Bun 支持顶层 await、JSX 和带有 .ts 扩展名的导入等特性,这些特性 TypeScript 默认是不允许的。下面是一组推荐的 Bun 项目 compilerOptions 配置,以便你可以使用这些特性而不会看到来自 TypeScript 的编译器警告。

jsonc
{
  "compilerOptions": {
    // 环境设置与最新特性
    "lib": ["ESNext"],
    "target": "ESNext",
    "module": "Preserve",
    "moduleDetection": "force",
    "jsx": "react-jsx",
    "allowJs": true,

    // 打包器模式
    "moduleResolution": "bundler",
    "allowImportingTsExtensions": true,
    "verbatimModuleSyntax": true,
    "noEmit": true,

    // 最佳实践
    "strict": true,
    "skipLibCheck": true,
    "noFallthroughCasesInSwitch": true,
    "noUncheckedIndexedAccess": true,
    "noImplicitOverride": true,

    // 一些更严格的标志 (默认禁用)
    "noUnusedLocals": false,
    "noUnusedParameters": false,
    "noPropertyAccessFromIndexSignature": false,
  },
}

如果你在新目录中运行 bun init,将会为你生成这份 tsconfig.json 文件。(更严格的标志默认是禁用的。)

sh
bun init