123
API Extractor

API Extractor

Rozhraní API Extractor vám pomáhá psát lepší knihovny TypeScript: Analyzuje vaše exportované podpisy typu a (1) vytváří webovou dokumentaci dokumentace API, (2) generuje soubor .d.ts "rollup" a (3) vytváří sestavu API pro usnadnění PRrecenze.
Rozhraní API Extractor pomáhá vývojářům TypeScript spravovat povrch API pro jejich knihovnu.Je distribuován jako balíček NPM „@ microsoft / api-extraktor“.Vytváří tři různé typy výstupů: - Report API - API Extractor může sledovat veškerý export z hlavního vstupního bodu vašeho projektu a generovat sestavu, která bude použita jako základ pro pracovní postup kontroly API.- .d.ts Rollups - Podobně jako může Webpack „shrnovat“ všechny vaše soubory JavaScriptu do jednoho balíčku pro distribuci, API Extractor může shrnout vaše TypeScript deklarace do jednoho souboru .d.ts.Tento soubor lze oříznout tak, aby vyloučil deklarace označené pomocí značek TSDoc, jako jsou @beta nebo @internal. - Dokumentace API - Nástroj vygeneruje pro každý váš projekt soubor JSON „doc model“. Tento soubor JSON obsahuje extrahované podpisy typu aDoprovodný nástroj „api-documenter“ může tyto soubory použít k vygenerování referenční webové stránky API nebo je můžete použít jako vstupy pro vlastní dokumentační potrubí.

Webová stránka:

Funkce

Kategorie

Alternativy API Extractor pro Software as a Service (SaaS)

Smartcar

Smartcar

Ve společnosti Smartcar pomáháme vývojářům budovat budoucnost mobility.