Typedoc:仅记录特定文件导出的内容
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 和错误 classes 从 errors/index.ts 导入并重新导出一些接口,但导入时不从中导出 class 数据库utils/database/index.ts。
实际导出时,数据库 class 之类的内容会被记录下来,即使它们是由不同于 index.ts 的文件导出的。
如何过滤它们?
typedoc 的当前@next 版本具有--library 模式。 @beta 版本和未来的 1.0.0 版本似乎会有很大的变化,模式选项甚至会消失。开发似乎进行得非常缓慢,所以我认为现在唯一的方法是使用(可能有问题的)@next 和 @beta 版本并等待。
编辑:0.20.x不再是测试版,已经发布,效果很好,所以问题解决了
我正在开发两个 npn 包:
我想使用 typedoc 记录它们。 index.js文件是npm模块提供的文件,通过index.ts获取。
我只想记录库 index.ts 导出的内容。我可以使用 typedoc 选项过滤未导出的内容。
问题是 index.ts 从其他 TS 文件导入内容并仅导出其中的一部分。例如,它从 interfaces/index.ts 和错误 classes 从 errors/index.ts 导入并重新导出一些接口,但导入时不从中导出 class 数据库utils/database/index.ts。
实际导出时,数据库 class 之类的内容会被记录下来,即使它们是由不同于 index.ts 的文件导出的。
如何过滤它们?
typedoc 的当前@next 版本具有--library 模式。 @beta 版本和未来的 1.0.0 版本似乎会有很大的变化,模式选项甚至会消失。开发似乎进行得非常缓慢,所以我认为现在唯一的方法是使用(可能有问题的)@next 和 @beta 版本并等待。
编辑:0.20.x不再是测试版,已经发布,效果很好,所以问题解决了