我正在使用typescript构建一个react库,我想为这个库的使用者提供一个打字稿定义文件。
如何确保打字稿定义文件总是正确匹配js代码?
或者如果我的组件是用typescript编写的,有没有办法从编译器为我生成的所有生成的d.ts文件生成一个d.ts文件?
答案 0 :(得分:5)
正如这里提到的:https://stackoverflow.com/a/65629179/10606346
使用 React 开箱即用的 .d.ts
文件的最简单方法是将其放入 src
文件夹并将其命名为 global.d.ts
如下:
src/global.d.ts
答案 1 :(得分:3)
如果您是图书馆的作者,那么提供和维护这些定义非常容易。无论您使用哪个库(例如React),它的工作方式都相同。
.d.ts
文件您可以通过将 .d.ts
传递给编译器参数或在{{1}中添加 -d
来创建declaration: true
文件}。
tsconfig.json
将project.json
字段添加到typings
,例如 project.json
(如果省略"typings": "./index.d.ts"
,./index.d.ts
实际上是默认值。
如果用户通过NPM安装库,TypeScript编译器将自动使用提供的类型。