123
API Extractor

API Extractor

API Extractor ви помага да пишете по-добре TypeScript библиотеки: Анализира вашите изнесени типови подписи и (1) създава уебсайт за документация за API, (2) генерира .d.ts "сборен" файл и (3) създава API отчет за улесняване на PRмнения.
API Extractor помага на разработчиците на TypeScript да управляват повърхността на API за своята библиотека.Той се разпространява като NPM пакет "@ microsoft / api-extractor".Той произвежда три различни типа изход: - API Report - API Extractor може да проследи целия износ от основната точка на вашия проект и да генерира отчет, който да се използва като основа за работен процес за преглед на API.- .d.ts Свиване - Подобно на това как Webpack може да „навие“ всички ваши JavaScript файлове в един пакет за разпространение, API Extractor може да навива вашите декларации TypeScript в един .d.ts файл.Този файл може да бъде отрязан, за да изключи декларации, маркирани с TSDoc тагове, като @beta "или @internal. - API Documentation - Инструментът генерира JSON файл на" doc model "за всеки от вашите проекти. Този JSON файл съдържа извлечените типове подписи иdoc коментари. Придружителният инструмент "api-documententer" може да използва тези файлове за генериране на референтен уебсайт на API, или можете да ги използвате като входни данни за тръбопровода с персонализирана документация.

Характеристика

Категории

Алтернативи на API Extractor за Software as a Service (SaaS) с лиценз за отворен код