node.js - npm 包的可安装 typescript 类型定义

Question

打字是 Typescript 最好的功能之一，我发现它非常有用，可以在整个 javascript 项目中采用它，但是用法和最佳实践并没有非常有效地记录下来，这给开发人员带来了很多困惑。

例如我的 npm 包名为 my-awesome-pkg对于这个包，我们感兴趣的是 @typings，用户可以使用 npm npm install @types/my-awesome-pkg 安装它

我知道如何使用 include或files在tsconfig.json在您的项目中包含并使用@typings:

"include": [ "< path to your typing file>" ]

但这不是我想要的，我有兴趣知道如何为我的项目创建可安装的 @typings，这样用户就不会在寻找我的 npm 包的类型时感到沮丧，因为假设有一个标准的做法来做到这一点。

谢谢

Answer 1

因此，如果您的项目是用 TypeScript 编写的，您所要做的就是在项目的 tsconfig.json 中设置以下标志:

"declaration": true,
"declarationDir": './anyFolderYouLike'

这将在运行 tsc 时为您的 TypeScript 项目生成类型。有关如何配置 tsc 的更多信息，请参阅 here .

许多人将他们的类型托管在DefinitelyTyped上。这样人们就应该能够按照您希望的方式安装类型。

我看到越来越多的人用自己的包来交付他们的类型。这样就不需要单独安装它们。如果您想这样做，您应该在 package.json 中指定类型位置，即:

"types": "./lib/index.d.ts"

有关发布的更多总体信息，请参阅TypeScript publishing documentation .