【发布时间】:2020-04-27 07:56:16
【问题描述】:
我正在开发两个 npn 包:
我想使用 typedoc 来记录它们。 index.js文件是npm模块提供的,通过index.ts获取。
我只想记录库 index.ts 导出的内容。我可以使用 typedoc 选项过滤未导出的内容。
问题在于 index.ts 从其他 TS 文件中导入内容并仅导出其中的一部分。例如,它从interfaces/index.ts 导入和重新导出一些接口,从errors/index.ts 导入和重新导出错误类,但在不从utils/database/index.ts 导出类Database 的情况下导入。
在实际导出时,即使数据库类是由不同于 index.ts 的文件导出的,也会记录在案。
如何过滤它们?
【问题讨论】:
-
在 v0.17(目前是
typedoc@next下的测试版)中,--mode library可以实现这一点 -
谢谢,我在 github repo 的项目部分注意到了。这什么时候会成为稳定版本的一部分?
-
我希望这个月能发布它,不过现在回到学校了,所以我没有太多时间去做。
标签: node.js typescript npm typedoc