我需要在每个文件中引用 TypeScript 定义吗？

TypeScript 是一个强类型的 JavaScript 超集，它提供了类型检查和其他一些功能以帮助开发者编写更加可靠和健壮的代码。然而，在使用 TypeScript 开发项目时，我们可能会遇到一个问题：我是否需要在每个文件中引用 TypeScript 定义文件（.d.ts）呢？本文将深入探讨这个问题，并为你提供相关指导。

简单回答

简单来说，不是必须要在每个文件中引用 TypeScript 定义文件。这是因为当你在项目中使用了 tsconfig.json 文件来配置 TypeScript 编译器时，编译器可以自动查找项目中所有的定义文件并将其包含在编译输出中。因此，只需在项目中的某个位置引用一次定义文件即可。

例如，如果我们有以下项目结构：

src/
├── index.ts
└── utils/
    ├── math.ts
    └── string.ts

那么，我们可以在 index.ts 文件中引用 utils/math.ts 中所定义的类型，而无需在 math.ts 和 string.ts 中再次引用。

// index.ts
import { Vector2 } from './utils/math';

const v: Vector2 = { x: 0, y: 0 };

深入探讨

虽然在大部分情况下我们可以仅在某个文件中引用定义文件，但是在以下情况下可能需要在每个文件中都引用定义文件：

1. 使用全局类型

如果你的项目中有一些全局类型（即在全局命名空间中定义的类型），那么你需要在每个文件中引用定义文件。这是因为 TypeScript 只会自动包含与当前文件相关的类型信息，而不会包含全局命名空间中的类型信息。

例如，我们有一个全局类型 MyGlobalType：

// global.d.ts
declare interface MyGlobalType {
  // ...
}

如果我们想在一个模块中使用该类型，我们需要在该模块中引用定义文件：

// module.ts
/// <reference path="./global.d.ts" />

const obj: MyGlobalType = { /* ... */ };

2. 定义模块或命名空间

如果你正在编写一个模块或命名空间的定义文件，那么你需要在每个使用该模块或命名空间的文件中引用定义文件。这是因为定义文件本身并不会自动包含到编译输出中。

例如，我们有一个定义文件 my-module.d.ts：

declare namespace MyModule {
  // ...
}

export = MyModule;

如果我们想在其他文件中使用该模块，我们需要在每个文件中引用定义文件：

// some-module.ts
/// <reference path="./my-module.d.ts" />

import myModule = require('./my-module');

myModule.doSomething();

最佳实践

虽然在大多数情况下我们可以仅在某个文件中引用定义文件，但为了确保代码的可读性和可维护性，最好在每个文件中都引用相关的定义文件。这样做可以让代码更加易于理解，并且可以避免潜在的编译错误。

另外，如果你正在编写一个库或框架，那么建议将所有的类型定义文件放在一个独立的文件夹中，并在 tsconfig.json 中配置该文件夹作为 include。这样可以确保编译器可以找到所有的类型定义文件，并自动包含它们在编译输出中。

{
  "compilerOptions": {
    // ...
  },
  "include": [
    "src/types"
  ]
}

结论

尽管

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/29199