我正在编写一个打字稿库,打算在其上发布npm
。它是为了运行node
仅,永远不会在浏览器中。仅从打字稿使用该库才有意义(我不期望任何 Javascript 用户)。
我很难找到如何在 npm 上发布 typescript-for-typescript 库的指南(而且,这些事情似乎在 typescript 世界中正在迅速变化)。
我应该将所有代码包装在一个module
? (我觉得库本身不需要模块,目前只有大约 1000 个 LOC)。我应该创建一个index.ts
文件?我想我应该发货.js
, .js.map
and .d.ts
文件但没有.ts
npm 包的文件?
如何在库中的文件之间调用函数而不将它们导出给库的用户?
我目前不使用打字稿模块。我尝试使用typedoc
它还列出了我从各个文件导出的符号,以便在库的另一个文件中使用。但我不希望图书馆的用户看到这些。
有一个图书馆可以用作示例吗?我在看打字稿集合 https://github.com/basarat/typescript-collections,他们不使用任何module
并有一个index.ts。我认为他们导出了所有共享功能,因此这对我解决这个问题没有帮助。
我所做的是index.ts
导出所有文件。
like
export { default as Actions } from './Actions'
然后,在你的 package.json 中,
添加属性"typings": "dist/index.d.ts"
(相应地更改位置)
是的,导出定义和源映射。其他人可以使用source-map-support
包以便稍后轻松调试。
我更喜欢将它们预先构建到.js
发布时。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)