代码之家 › 专栏 › 技术社区 › Milad Rezazadeh

npm包的可安装typescript类型定义

typescript-typings packages npm typescript node.js

1

Milad Rezazadeh · 技术社区 · 8 年前

键入是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包的类型时不会感到沮丧,因为假设有一个标准的实践来完成它。

谢谢

1 回复 | 直到 8 年前

1

2

ãã¼ãºãã³ Mumtaz Ali Awan 8 年前

因此,如果您的项目是用TypeScript编写的,那么您所要做的就是在项目的 tsconfig.json :

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

这将为您的TypeScript项目生成类型 tsc 正在运行。有关如何配置的更多信息 tsc公司 看见 here 。

许多人在 DefinitelyTyped . 这样一来,就可以按照您希望的方式安装这些类型。

不过,我看到越来越多的人用自己的软件包交付自己的类型。这样就不需要单独安装它们。如果要这样做,应在 package.json ,即:

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

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