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

Question

我创建了一个 npm 包 (https://github.com/d6u/observe-object-path)。它是用打字稿写的。它有一个构建步骤将其编译为 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 文件，您必须在编译器配置中启用 declaration 选项。

tsconfig.json 的示例。

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