为我的 react 打字稿组件库生成/维护打字稿定义文件

Question

我正在用打字稿构建一个反应库，我想为这个库的使用者提供一个打字稿定义文件。

我如何确保打字稿定义文件始终正确匹配 js 代码？

或者，如果我的组件是用打字稿编写的，有没有办法从编译器为我生成的所有生成的 d.ts 文件中生成单个 d.ts 文件？

Answer 1

如果您是库的作者，则提供和维护定义非常容易。无论您使用什么库（例如 React），它的工作方式都相同。

1. 创建.d.ts文件

您可以.d.ts通过传递-d给编译器参数或declaration: true在您的tsconfig.json.

2. 添加定义 package.json

将命名的字段添加typings到您的project.json，例如"typings": "./index.d.ts"（./index.d.ts如果typings省略，则实际上是默认值）。

如果用户通过 NPM 安装您的库，TypeScript 编译器将自动使用提供的类型。

更多信息：为 NPM 包
编写声明文件
类型

Answer 2

正如这里提到的：https : //stackoverflow.com/a/65629179/10606346

.d.ts使用 React 开箱即用的文件的最简单方法是将其放入src文件夹并将其命名为global.d.ts：

src/global.d.ts