npm 包的可安装打字稿类型定义
Installable typescript type definitions for an npm package
打字是 Typescript 最好的功能之一,我发现它非常有用,在整个 javascript 项目中都采用了它,但是使用和最佳实践并没有非常有效地记录下来,这导致了很多混乱对于开发人员。
例如我的名为 my-awesome-pkg
的 npm 包,对于这个包,我们有兴趣使用 @typings,用户可以使用 npm npm install @types/my-awesome-pkg
安装它
我知道如何在 tsconfig.json
中使用 include
或 files
在您的项目中包含和使用 @typings :
"include": [ "< path to your typing file>" ]
但这不是我要找的东西,我很想知道如何为我的项目创建可安装的@typings,这样用户就不会因为寻找我的 npm 包的类型而感到沮丧,就像假设的那样有一个标准的做法。
谢谢,
因此,如果您的项目是用 TypeScript 编写的,您只需在项目的 tsconfig.json
中设置以下标志:
"declaration": true,
"declarationDir": './anyFolderYouLike'
当 tsc
为 运行 时,这将为您的 TypeScript 项目生成类型。有关如何配置 tsc
的更多信息,请参阅 here。
许多人在 DefinitelyTyped 上托管他们的类型。这样应该能够按照您希望的方式安装类型。
我看到越来越多的人用他们自己的包来交付他们的类型。这样就不需要单独安装它们了。如果你想这样做,你应该在 package.json
中指定类型位置,即:
"types": "./lib/index.d.ts"
有关发布的更多整体信息,请参阅 TypeScript publishing documentation。
打字是 Typescript 最好的功能之一,我发现它非常有用,在整个 javascript 项目中都采用了它,但是使用和最佳实践并没有非常有效地记录下来,这导致了很多混乱对于开发人员。
例如我的名为 my-awesome-pkg
的 npm 包,对于这个包,我们有兴趣使用 @typings,用户可以使用 npm npm install @types/my-awesome-pkg
我知道如何在 tsconfig.json
中使用 include
或 files
在您的项目中包含和使用 @typings :
"include": [ "< path to your typing file>" ]
但这不是我要找的东西,我很想知道如何为我的项目创建可安装的@typings,这样用户就不会因为寻找我的 npm 包的类型而感到沮丧,就像假设的那样有一个标准的做法。
谢谢,
因此,如果您的项目是用 TypeScript 编写的,您只需在项目的 tsconfig.json
中设置以下标志:
"declaration": true,
"declarationDir": './anyFolderYouLike'
当 tsc
为 运行 时,这将为您的 TypeScript 项目生成类型。有关如何配置 tsc
的更多信息,请参阅 here。
许多人在 DefinitelyTyped 上托管他们的类型。这样应该能够按照您希望的方式安装类型。
我看到越来越多的人用他们自己的包来交付他们的类型。这样就不需要单独安装它们了。如果你想这样做,你应该在 package.json
中指定类型位置,即:
"types": "./lib/index.d.ts"
有关发布的更多整体信息,请参阅 TypeScript publishing documentation。