0
API Extractor
Rozhranie API Extractor vám pomáha písať lepšie knižnice TypeScript: Analyzuje vaše exportované podpisy typov a (1) vytvára webovú stránku dokumentácie API, (2) generuje súbor .d.ts "rollup" a (3) vytvára správu API na uľahčenie PRhodnotenia.
- Bezplatná
- Self-Hosted
- Windows
- Mac
- Linux
API Extractor pomáha vývojárom TypeScript spravovať povrch API pre svoju knižnicu.Distribuuje sa ako balík NPM „@ microsoft / api-extraktor“.Vytvára tri rôzne typy výstupov: - Report API - API Extractor môže sledovať všetok export z hlavného vstupného bodu vášho projektu a generovať správu, ktorá sa použije ako základ pre pracovný tok kontroly API.- .d.ts Rollups - Podobne ako Webpack dokáže „zhrnúť“ všetky vaše súbory JavaScriptu do jedného zväzku na distribúciu, API Extractor môže zhrnúť vaše deklarácie TypeScript do jedného súboru .d.ts.Tento súbor je možné orezať tak, aby vylúčil deklarácie označené pomocou značiek TSDoc, ako sú @ beta alebo @internal. - Dokumentácia API - Nástroj vygeneruje súbor JSON „doc model“ pre každý z vašich projektov. Tento súbor JSON obsahuje extrahované podpisy typov aSprievodný nástroj „api-documenter“ môže tieto súbory použiť na vygenerovanie referenčnej webovej stránky API alebo ich môžete použiť ako vstupy pre vlastný dokumentačný kanál.
api-extractor