如何在Typescript中为NPM声明模块公共类型定义

Question

我创建了一个npm包（https://github.com/d6u/observe-object-path）。它是用Typescript写的。它有一个编译步骤将其编译为ES5，这样任何JavaScript环境都可以使用它（https://github.com/d6u/observe-object-path/blob/master/package.json#L39-L41）。

1. 由于该模块已经写在Typescript中。是否有可能为我的包自动生成一个.d.ts文件，因此使用Typescript的用户可以在最少配置或无需配置的情况下使用它？

2. 如果自动生成是不可能的，什么是放置.d.ts文件的最佳场所，ts目录下（这显然是什么的Rx 4是做https://github.com/Reactive-Extensions/RxJS/tree/master/ts）？

Answer 1

要生成.d.ts为你的项目，你必须启用编译器配置的声明选项文件。

以为例tsconfig.json。

{ 
    "compilerOptions": { 
     "module": "system", 
     "target": "es5", 
     "noImplicitAny": false, 
     "sourceMap": false, 
     "experimentalDecorators": true, 
     "declaration": true 
    }, 
    "exclude": [ 
     "node_modules" 
    ] 
}