@preapproved

タグの種類: 修飾子

TSDoc 標準化: なし; このタグは API エクストラクター独自のものです

API が@internalとしてマークされていても、API レビュープロセスでは内部APIにも関心があるため、API レポートファイル（*.api.md ファイル）にはシグネチャが依然として記録されます。例えば、以下のような質問がされます。

「この変更によって他の内部パッケージに問題が発生しますか？」
「これを@public API にするべきでしょうか？」
「なぜあの巨大な「InternalUtilities」クラスにどんどん機能を追加し続けるのでしょうか？」

ただし、特定のAPIのレビューが役に立たない場合は、@preapprovedとしてマークできます。これにより、APIファイルへの出力は防止され、レビューポリシーから除外されます。

@preapprovedタグは、@internalとしてマークされた宣言でのみサポートされ、以下の宣言タイプでのみ使用できます。

クラス
列挙型
インターフェース
名前空間

使用例

/**
 * Identifiers for various log messages.
 *
 * @privateRemarks
 * These tokens are generated by the tooling system, so there is no reason
 * to review them.
 *
 * @internal @preapproved
 */
export enum _LoggingIds {
  ...
}

参照​

参照