用 Typescript 编写的 NPM 包 - 定义面向公众的 API

Question

我想发布一个用 Typescript 编写的 npm 包。

就打字而言，我目前的方法是简单地让tsc通过delaration:true设置为每个文件生成一个.d.ts 。 我听说你需要一个单一的index.d.ts（这是我一次发射与DTS-发生器，它似乎并没有提供对IDE的任何类型的援助），虽然打字稿的本地地图似乎工作okayish。

我尝试将所有公共 API 导入src/index.ts并将其导出，然后将package.json的main设置为dist/index.js ，但是似乎 IDE 更喜欢深入挖掘我的包文件（例如，在键入MainClass WebStorm 建议my-package/dist/MainClass和my-package/dist ），而不是简单地导入包本身，例如import {MainClass} from "myPackage" 。 后者确实有效（可能是由于所有内容都从index/index.js重新导出，但 IDE 显示此类建议的事实让我认为我的包结构有问题。

这是 repo 的链接。

Answer 1

我认为你应该尝试以下

• 保留一个 index.ts "barrel" 文件来导出所有公共 API（例如src/index.ts ）
• delaration:true很好，继续保持 :)
• 用 tsc 编译到一个单独的文件夹（例如./dist ）。 你可以 .gitignore 它
• 在你的 package.json 你应该做两件事：
  • “main”应该指向你编译的 index.js 文件（例如dist/index.js
  • “类型”应该指向您生成的类型定义索引（例如dist/index.d.ts 。我认为这是您的案例中的缺失点。您可以在此处阅读有关该主题的更多信息。

现在导入应如下所示：

import { MyClass } from "myPackage"