0
API Extractor
L'API Extractor vous aide à écrire de meilleures bibliothèques TypeScript: il analyse vos signatures de type exportées et (1) produit un site Web de documentation API, (2) génère un fichier "rollup" .d.ts et (3) crée un rapport API pour faciliter les relations publiquesCommentaires.
- Gratuite
- Self-Hosted
- Windows
- Mac
- Linux
L'API Extractor aide les développeurs TypeScript à gérer la surface API de leur bibliothèque.Il est distribué sous forme de package NPM "@ microsoft / api-extractor".Il produit trois types de sortie différents: - Rapport API - L'Extracteur API peut suivre toutes les exportations à partir du point d'entrée principal de votre projet et générer un rapport à utiliser comme base pour un flux de travail de révision API.- Rolls .d.ts - Similaire à la façon dont Webpack peut «roll up» tous vos fichiers JavaScript dans un seul bundle pour la distribution, API Extractor peut roll up vos déclarations TypeScript dans un seul fichier .d.ts.Ce fichier peut être coupé pour exclure les déclarations marquées à l'aide de balises TSDoc telles que @beta "ou @internal. - Documentation API - L'outil génère un fichier JSON" doc model "pour chacun de vos projets. Ce fichier JSON contient les signatures de type extraites etdoc doc. L'outil compagnon "api-documenter" peut utiliser ces fichiers pour générer un site Web de référence d'API, ou vous pouvez les utiliser comme entrées pour un pipeline de documentation personnalisé.
api-extractor