Skip to content

要安装 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,

    // Bundler 模式
    "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

Bun学习网由www.bunjs.com.cn整理维护