什么是 API Extractor?
API Extractor 是一个 TypeScript 分析工具,它生成三种不同的输出类型
1. API 报告 - API Extractor 可以跟踪项目主入口点的所有导出,并生成一个报告,用作 API 审查工作流程的基础。
2. .d.ts 汇总 - 与 Webpack 可以将所有 JavaScript 文件 "汇总" 成一个用于分发的捆绑包类似,API Extractor 可以将您的 TypeScript 声明汇总到一个 .d.ts 文件中。
3. API 文档 - API Extractor 可以为您的每个项目生成一个 "文档模型" JSON 文件。此 JSON 文件包含提取的类型签名和文档注释。api-documenter 伴侣工具可以使用这些文件生成 API 参考网站,或者您可以将它们用作自定义文档管道的输入。