[英]Typedoc: document only things exported by a specific file
我正在开发两个 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 的文件导出的,也会被记录下来。
我怎样才能过滤它们?
当前的 @next 版本的 typedoc 有一个 --library 模式。 似乎@beta 版本和未来的 1.0.0 版本会有很大的变化,模式选项甚至会消失。 开发似乎进行得非常缓慢,所以我认为现在唯一的方法是使用(可能有问题)@next 和 @beta 版本并等待。
编辑:0.20.x 不再是测试版,已经发布,效果很好,所以问题解决了
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.