TypeScript -- declare module

在 TypeScript 中，declare module 语句用于扩展或修改现有的模块的类型定义，而不需要提供具体的实现。这通常用于为第三方库或模块声明类型，特别是当库本身没有提供类型定义文件时。

declare module 允许你为模块添加、修改或覆盖类型声明，例如接口、类型别名、函数声明等。这对于在使用没有类型定义的 JavaScript 库时非常有用，因为它可以让你在 TypeScript 项目中安全地使用这些库。

使用 declare module 的例子

假设你正在使用一个名为 my-library 的第三方 JavaScript 库，但没有可用的 TypeScript 类型定义。你可以创建一个 .d.ts 文件（例如 my-library.d.ts），并在其中使用 declare module 来声明库的类型。

// my-library.d.ts

// 声明 my-library 模块，并为其添加一个函数的类型声明
declare module 'my-library' {
  export function doSomething(a: number, b: number): number;

  // 你可以继续添加更多的类型声明，例如接口、类等
  interface MyLibraryOptions {
    enableLogging?: boolean;
  }
}

在上面的例子中，我们为 my-library 模块添加了一个函数 doSomething 的类型声明，以及一个 MyLibraryOptions 接口。这样，当你在 TypeScript 项目中使用 my-library 时，就可以获得类型检查和自动完成功能。

如何使用声明的模块

在你的 TypeScript 项目中，你现在可以像使用带有类型定义的模块一样使用 my-library：

// app.ts

import * as myLib from 'my-library';

// 现在可以使用 doSomething 函数，并且会有类型检查和自动完成
myLib.doSomething(2, 3);

// 也可以使用 MyLibraryOptions 接口
const options: myLibrary.MyLibraryOptions = { enableLogging: true };

通过这种方式，declare module 使得你可以为任何 JavaScript 库提供 TypeScript 类型声明，从而在 TypeScript 项目中获得更好的开发体验。需要注意的是，declare module 只是声明了类型，并不会生成任何实际的 JavaScript 代码。因此，当你使用 declare module 时，确保相应的 JavaScript 库已经在你的项目中可用。