API Extractor

API Extractor

API Extractor pomaže vam u pisanju boljih biblioteka TypeScript: analizira vaše izvozne potpise tipa i (1) izrađuje web lokaciju s dokumentacijom API-ja, (2) generira .d.ts datoteku "rolne" i (3) kreira API izvješće za olakšavanje PR-amišljenja.
API Extractor pomaže programerima TypeScript-a da upravljaju površinom API-ja za svoju biblioteku.Distribuira se kao NPM paket "@ microsoft / api-extractor".Izrađuje tri različite vrste izlaza: - API izvješće - API Extractor može pratiti sav izvoz iz glavne ulazne točke vašeg projekta i generirati izvješće koje će se koristiti kao osnova za tijek pregleda API-ja.- .d.ts Sažetak - Slično kao što Webpack može „izvesti“ sve vaše JavaScript datoteke u jedan paket za distribuciju, API Extractor može navesti vaše TypeScript deklaracije u jednu .d.ts datoteku.Ova se datoteka može obrezati tako da izuzme deklaracije označene pomoću TSDoc oznaka kao što su @beta "ili @internal. - API Dokumentacija - Alat generira JSON datoteku" doc model "za sve vaše projekte. Ova JSON datoteka sadrži izdvojene tipove potpisa idoc komentari. Alat za popunjavanje "api-dokumentarista" može koristiti te datoteke za stvaranje referentne web stranice API-ja ili ih možete koristiti kao ulaze za prilagođeni cjevovod za dokumentaciju.

Značajke

Kategorije

Alternativa API Extractoru za Android s komercijalnom licencom