API Extractor

API Extractor

API Extractor hilft Ihnen beim Schreiben besserer TypeScript-Bibliotheken: Es analysiert Ihre exportierten Typensignaturen und (1) erstellt eine API-Dokumentationswebsite, (2) erstellt eine .dts- "Rollup" -Datei und (3) erstellt einen API-Bericht, um PR zu erleichternBewertungen.
Mit API Extractor können TypeScript-Entwickler die API-Oberfläche für ihre Bibliothek verwalten.Es wird als NPM-Paket "@ microsoft / api-extractor" vertrieben.Es werden drei verschiedene Ausgabetypen erstellt: - API-Bericht - API-Extraktor kann alle Exporte vom Haupteinstiegspunkt Ihres Projekts nachverfolgen und einen Bericht erstellen, der als Grundlage für einen API-Überprüfungsworkflow dient.- .d.ts-Rollups - Ähnlich wie Webpack alle Ihre JavaScript-Dateien für die Verteilung in einem einzigen Bundle zusammenfassen kann, kann API Extractor Ihre TypeScript-Deklarationen in eine einzige .d.ts-Datei zusammenfassen.Diese Datei kann so gekürzt werden, dass mit TSDoc-Tags wie "@beta" oder "@internal" gekennzeichnete Deklarationen ausgeschlossen werden. - API-Dokumentation - Das Tool generiert eine JSON-Datei "doc model" für jedes Ihrer Projekte. Diese JSON-Datei enthält die extrahierten Typensignaturen unddoc-Kommentare: Das Hilfsprogramm "api-documenter" kann diese Dateien zum Generieren einer API-Referenzwebsite verwenden oder Sie können sie als Eingaben für eine benutzerdefinierte Dokumentationspipeline verwenden.
api-extractor

Eigenschaften

Kategorien

API Extractor-Alternativen für Mac

Docma

Docma

Docma ist ein leistungsstarkes Tool, mit dem Sie auf einfache Weise eine ansprechende HTML-Dokumentation aus Javascript- (JSDoc), Markdown- und HTML-Dateien erstellen können.
Smartcar

Smartcar

Bei Smartcar geben wir Entwicklern die Möglichkeit, die Zukunft der Mobilität zu gestalten.