javascript - 如何在 Typescript 中声明 NPM 的模块公共(public)类型定义

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"
    ]
}