TypeScript 中的 allowJs

说明 allowJs 如何让 TypeScript 项目接纳 .js 文件，以及它为什么常用于 JS 到 TS 的渐进迁移。

#dev #typescript #concept #growing

[!info] related notes

所属 MOC: TypeScript MOC

配置入口: tsconfig 使用详解

并列概念: TypeScript 中的 checkJs, TypeScript 中的 emitDeclarationOnly

一句话定义

allowJs 允许 TypeScript 项目把 .js 文件也纳入 program，而不只接受 .ts / .tsx。

官方文档直接说明：

这意味着 TypeScript 不再把 .js 文件视为“项目外部世界”，而是允许它们和 .ts、.tsx 并存。

例如：

{
  "compilerOptions": {
    "allowJs": true
  }
}

之后：

import { defaultCardDeck } from "./card";

就可以合法地指向 card.js。

allowJs 最常见的用途就是：

官方文档也明确把它描述成：

allowJs 只是先让 .js 文件进来。

是否真的对 JS 文件报类型错误，更接近：

官方文档还特别指出，它可以和：

一起使用，用来为 JS 文件生成类型声明。

如果项目长期大量混用 JS/TS，却没有边界策略，后期类型体验还是容易混乱。