一尘不染

用Typescript编写NPM模块

node.js

我正在第一个NPM模块上工作。之前,我曾短暂地使用过Typescript,但一个大问题是,对于许多模块,没有可用的定义文件。因此,我认为用打字稿编写模块是一个好主意。

但是,我找不到有关最佳方法的任何信息。我发现了一个相关的问题“
我可以在coffeescript中编写npm软件包吗?
”,那里的人们建议只发布javascript文件。但是与coffeescript文件相比,如果在打字稿应用程序中使用打字稿文件,它们实际上可能会很有用。

发布NPM模块时应该包含Typescript文件,还是仅发布javascript文件并将生成的.d.ts文件提供给DefinitelyTyped?


阅读 336

收藏
2020-07-07

共1个答案

一尘不染

这是用TypeScript编写的示例Node模块:https :
//github.com/basarat/ts-npm-module

这是使用此示例模块的示例TypeScript项目https://github.com/basarat/ts-npm-module-
consume

基本上,您需要:

  • commonjs和编译declaration:true
  • 生成.d.ts文件

然后

  • 让您的助手阅读生成的.d.ts

Atom-TypeScript为此提供了一个不错的工作流程:https : //github.com/TypeStrong/atom-
typescript#packagejson-support

2020-07-07