API Extractor

API Extractor

API Extractor hjælper dig med at skrive bedre TypeScript-biblioteker: Den analyserer dine eksporterede typesignaturer og (1) producerer et API-dokumentationswebsted, (2) genererer en .d.ts "rulllup" -fil, og (3) opretter en API-rapport for at lette PRanmeldelser.
API Extractor hjælper TypeScript-udviklere med at administrere API-overfladen til deres bibliotek.Den distribueres som en NPM-pakke "@ microsoft / api-extractor".Det producerer tre forskellige outputtyper: - API-rapport - API Extractor kan spore al eksport fra dit projekt hovedindgangspunkt og generere en rapport, der skal bruges som grundlag for en API-gennemgangs-arbejdsgang.- .d.ts Rollups - Ligesom hvordan Webpack kan "rulle op" alle dine JavaScript-filer til et enkelt bundt til distribution, kan API Extractor rulle dine TypeScript-erklæringer til en enkelt .d.ts-fil.Denne fil kan beskæres for at ekskludere erklæringer markeret ved hjælp af TSDoc-tags såsom @beta "eller @intern. - API-dokumentation - Værktøjet genererer en" doc-model "JSON-fil til hvert af dine projekter. Denne JSON-fil indeholder de udpakkede typesignaturer ogdoc-kommentarer. Ledsagerværktøjet "api-documenter" kan bruge disse filer til at generere et API-referencewebsted, eller du kan bruge dem som input til en brugerdefineret dokumentationspipeline.

Funktioner

Kategorier

Alternativer til API Extractor til Mac

Docma

Docma

Docma er et kraftfuldt værktøj til let at generere smuk HTML-dokumentation fra Javascript (JSDoc), Markdown og HTML-filer.
Smartcar

Smartcar

Hos Smartcar giver vi udviklere mulighed for at opbygge fremtiden for mobilitet.