123
API Extractor

API Extractor

API Extractor pomaga pisać lepsze biblioteki TypeScript: analizuje wyeksportowane podpisy typów i (1) tworzy stronę internetową z dokumentacją API, (2) generuje plik „rollup” .d.ts, oraz (3) tworzy raport API ułatwiający PRrecenzje.
API Extractor pomaga programistom TypeScript zarządzać powierzchnią API dla ich biblioteki.Jest dystrybuowany jako pakiet NPM „@ microsoft / api-extractor”.Tworzy trzy różne typy danych wyjściowych: - Raport API - API Extractor może śledzić wszystkie eksporty z głównego punktu wejścia projektu i generować raport, który posłuży jako podstawa dla przepływu pracy przeglądu API.- Pakiety .d.ts - Podobnie jak Webpack może „zrolować” wszystkie pliki JavaScript w jeden pakiet do dystrybucji, API Extractor może zrolować deklaracje TypeScript do pojedynczego pliku .d.ts.Ten plik można przyciąć, aby wykluczyć deklaracje oznaczone przy użyciu znaczników TSDoc, takich jak @beta "lub @internal. - Dokumentacja API - Narzędzie generuje plik JSON„ model dokumentu "dla każdego projektu. Ten plik JSON zawiera podpisy wyodrębnionego typu ikomentarze do dokumentu. Narzędzie towarzyszące „api-documenter” może wykorzystywać te pliki do generowania referencyjnej strony internetowej API lub można ich użyć jako danych wejściowych dla potoku niestandardowej dokumentacji.

Stronie internetowej:

cechy

Kategorie

Alternatywy dla API Extractor dla Self-Hosted z licencją komercyjną