如何在Typescript中為NPM聲明模塊公共類型定義

Question

我創建了一個npm包（ https://github.com/d6u/observe-object-path ）。 它用Typescript編寫。 它具有將其編譯到ES5的構建步驟，因此任何JavaScript環境都可以使用它（ https://github.com/d6u/observe-object-path/blob/master/package.package#json39-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"
    ]
}