API パッケージ

これらのNPMパッケージは、すべてのRush Stackプロジェクトの統合APIリファレンスで文書化されている開発者APIをエクスポートします。

• @microsoft/api-extractor APIドキュメント

  これは、ツールチェーンからAPIエクストラクターエンジンを呼び出すために使用されます。APIエクストラクターの呼び出しチュートリアルにコードサンプルが示されています。

• @microsoft/api-extractor-model APIドキュメント

  これは、.api.jsonデータモデルを読み取るために使用されます（例：カスタムドキュメントツールの実装）。このパッケージのNPMページにはコードサンプルが表示されています。

• @microsoft/api-documenter APIドキュメント

  これは、APIドキュメンターツールの出力をカスタマイズするプラグインを作成するために使用されます。これは実験的な新機能です。使用例については、repo-scripts/doc-plugin-rush-stackプロジェクトをご覧ください。このプロジェクトはJekyllヘッダーをAPIドキュメンターのマークダウン出力に追加します。repo-scripts/generate-api-docsプロジェクトでは、このプラグインを使用してRush Stack APIリファレンスを生成します。generate-api-docs.cmdスクリプトを実行することで呼び出されます。プラグインはapi-documenter.json設定ファイルに登録されています。api-documenter-template.jsonファイルテンプレートには、すべての設定に関するドキュメントが含まれています。