TypeScript是目前大受欢迎的开发语言之一，它提供了强类型定义和代码提示，能够使得开发者的代码更加严谨和高效。但是，一个好的TypeScript库绝不仅仅是一个 .js 文件，它需要一个.d.ts文件来提供类型定义。在实际的开发过程中，我们会遇到种种问题，如何测试一个.
d.ts文件是否正确？如何生成一个.d.ts文件？如何自动生成一个.d.ts文件？
这时，一个名为 typescript-definition-tester 的NPM包可以解决你的问题。本文将详细介绍如何使用 typescript-definition-tester 以及如何生成完整的和正确的 .d.ts 文件。
typescript-definition-tester
typescript-definition-tester 是一个 NPM包，它可以负责测试 TypeScript 类型定义是否正确。
在安装之前，我们需要确保 Node.js 和 TypeScript 已经正确安装。
你可以使用以下命令来安装 typescript-definition-tester:
npm install --save-dev typescript-definition-tester
或者使用 yarn：
yarn add typescript-definition-tester --dev
开始使用
现在，我们来看一下如何使用 typescript-definition-tester 对一个类库的类型定义进行测试。
在本例中，我们将使用一个小型类库 -- my-package：
export function myPackageFunction(x: number, y: number): number {
return x + y;
}我们需要为这个类库编写一份 .d.ts 文件，才能在其他应用程序中正确地使用它。 首先，我们写一个名为 index.d.ts 的文件，并使用以下代码来定义 my-package 的类型定义：
declare function myPackageFunction(x: number, y: number): number; export = myPackageFunction;
接下来，我们使用 typescript-definition-tester 来测试这个文件，我们在目录中创建一个 test.ts 文件,它实现了对 my-package 的测试：
-- -------------------- ---- -------
------ - ------ - ---- -------------------------------
------ - -- ---- ---- -------
----- ------------ - -------------------- --------------
----- ------ - --- --------
------------- -------------------- ------------------
---
---------------------------在上述代码中，我们导入并实例化 Tester，为了获得更好的控制，我将配置对象传递给构造函数。在上述示例中，我将 tsconfigPath 属性设置为 tsconfig.json 文件的路径。 这个借助 TypeScript 编译器运行测试，当测试运行时，TypeScript 编译器将执行以下操作：
- 从
tsconfig.json中读取配置 - 编译测试文件（test.ts)
- 读取类型定义文件（此处是
index.d.ts），并由可执行文件来测试它们是否正确
我们将使用以下命令来运行测试：
npx ts-node test.ts
如果一切正常，我们会得到以下输出：
✨ Done in 2.09s.
如果输出中有错误， 我们就需要去检查 index.d.ts 文件。
.d.ts文件生成
在使用 typescript-definition-tester 进行类型定义测试时，我们使用了一份手工编写的 .d.ts 文件。然而在实际情况中，当我们需要拥有一个新库时，我们可以经常开始尝试写类型定义文件。
实际上，我们并不需要手动编写 TypeScript 类型定义文件，因为 TypeScript 提供了一个 --declaration 选项，它可以帮助我们自动生成 .d.ts 文件，我们可以将 tsc 命令和 --declaration 选项结合起来使用，来自动生成.d.ts文件。
首先，我们在 package.json 文件中添加以下配置：
"scripts": {
"build": "tsc --declaration"
},接下来，我们对 my-package 做一些修改：
export function myPackageFunction(x: number, y: number): number {
return x + y;
}
export function myOtherPackageFunction(z: number): number {
return z * 2;
}运行以下命令将产生 js 和 d.ts 文件。
npm run build
现在我们可以看到，一个名为 my-package.d.ts 的文件自动生成了！ 看看它的内容：
export declare function myPackageFunction(x: number, y: number): number; export declare function myOtherPackageFunction(z: number): number;
然后，我们就可以使用 typescript-definition-tester 对它进行测试了。
需要注意的是，自动生成的 .d.ts 文件只能覆盖你目前编写的类型定义的一小部分。因此，在编写类型定义之前，请先查看是否有现成的类型定义文件。 在开源的库中，可以在通用的 @types 包中找到类型定义文件。在 @types/package-name 中就可以找到对应的库的类型定义。
总结
本文介绍了如何使用npm 包 typescript-definition-tester 来测试类型定义是否正确，并介绍了自动生成TypeScript类型定义文件的方法。这些技术可以使我们更容易地编写和维护类型定义文件。正是这些定义让我们的代码更加严谨并且提高了开发效率。随着 TypeScript 对于 JavaScript 生态的积极推动，TypeScript 对我们 web 开发人员的启示变得越来越重要。希望本教程对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/typescript-definition-tester