API 抽出器とは？

API 抽出器は 3 つの異なる種類の出力を作成する TypeScript 解析ツールです

1. API レポート - API 抽出器はプロジェクトのメインエントリポイントからすべてのエクスポートを追跡し、API レビューワークフローのベースとして使用できるレポートを生成できます。

2. .d.ts ロールアップ - Webpack が配布用にすべての JavaScript ファイルを 1 つのバンドルに「ロールアップ」する方法と同様に、API 抽出器は TypeScript の宣言を 1 つの .d.ts ファイルにロールアップできます。

3. API ドキュメント - API Extractor は、各プロジェクトの「doc model」JSON ファイルを生成できます。この JSON ファイルには、抽出された型のシグネチャとドキュメント コメントが含まれます。コンパニオン ツールのapi-documenterは、これらのファイルを使用して API リファレンス Web サイトを生成できます。また、カスタムのドキュメント パイプラインへの入力として使用することもできます。