API Extractor

API Extractor

API Extractor hjälper dig att skriva bättre TypeScript-bibliotek: Den analyserar dina exporterade typsignaturer och (1) producerar en API-dokumentationswebbplats, (2) genererar en .d.ts "samlingsfil" och (3) skapar en API-rapport för att underlätta PRrecensioner.
API Extractor hjälper TypeScript-utvecklare att hantera API-ytan för deras bibliotek.Det distribueras som ett NPM-paket "@ microsoft / api-extractor".Den producerar tre olika utgångstyper: - API-rapport - API Extractor kan spåra all export från projektets huvudinmatningspunkt och generera en rapport som ska användas som grund för ett API-granskningsarbetsflöde.- .d.ts Rollups - I likhet med hur Webpack kan "rulla upp" alla dina JavaScript-filer till ett enda paket för distribution, kan API Extractor rulla upp dina TypeScript-deklarationer till en enda .d.ts-fil.Denna fil kan trimmas för att utesluta deklarationer markerade med TSDoc-taggar som @beta "eller @intern. - API-dokumentation - Verktyget genererar en" doc-modell "JSON-fil för vart och ett av dina projekt. Denna JSON-fil innehåller de extraherade typsignaturerna ochdoc-kommentarer. "Api-documenter" -följverktyget kan använda dessa filer för att generera en API-referenswebbplats, eller du kan använda dem som input för en anpassad dokumentationspipeline.

Funktioner

kategorier

Alternativ till API Extractor för alla plattformar med kommersiell licens