@internal
タグタイプ: 修飾子
TSDoc の標準化: 任意
@internal
修飾子は 4 つのリリース タグのうちの 1 つです。API 項目は同じメンテナーからの他の NPM パッケージでのみ使用されることを示しています。サードパーティは「内部」API を使用しないでください。これを強調するために、(明示的な)@internal
タグを持つ宣言の名前にはアンダースコアプレフィックスを使用する必要があります。API 抽出ツールはこの命名規則を検証し、アンダースコアがなければ ae-internal-missing-underscore を報告します。
使用例
/**
* This is some example documentation.
* @internal
*/
export function _doSomething(): void {}