API Extractor

API Extractor

API Extractor可帮助您编写更好的TypeScript库:它分析您导出的类型签名,并且(1)生成一个API文档网站,(2)生成一个.d.ts“汇总”文件,以及(3)创建一个API报告以促进PR评论。
API Extractor可帮助TypeScript开发人员管理其库的API表面。它作为NPM软件包“ @ microsoft / api-extractor”分发。它产生三种不同的输出类型:-API报告-API提取器可以跟踪项目主入口点的所有导出,并生成报告以用作API审查工作流的基础。-.d.ts汇总-与Webpack如何将所有JavaScript文件“汇总”到单个分发包中一样,API Extractor可以将TypeScript声明汇总到单个.d.ts文件中。可以对该文件进行修整以排除使用TSDoc标记(例如@beta”或@internal)标记的声明。-API文档-该工具会为您的每个项目生成一个“文档模型” JSON文件。该JSON文件包含提取的类型签名和doc注释:“ api-documenter”配套工具可以使用这些文件来生成API参考网站,也可以将它们用作自定义文档管道的输入。
api-extractor

特征

分类目录

具有商业许可证的Android版API Extractor的替代方案