簡體   English   中英

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 導入和重新導出一些接口,從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.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM