Бесплатное ПО Открытый код

Категории: Разработка

Платформы: Mac Linux Windows

Ссылки: Официальный сайт Github

Особенности:
documentation-generator developer-tools api documentation self-hosted typescript nodejs tsdoc

API Extractor помогает разработчикам TypeScript управлять поверхностью API для
своей библиотеки. Он распространяется в виде пакета NPM "@ microsoft / api-
extractor". Он производит три разных типа вывода:

\- Отчет API - API Extractor может отслеживать все экспорты из основной точки
входа вашего проекта и генерировать отчет, который будет использоваться в
качестве основы для рабочего процесса проверки API.

\- .d.ts Rollups - Подобно тому, как Webpack может «свернуть» все ваши файлы
JavaScript в один пакет для распространения, API Extractor может свернуть ваши
объявления TypeScript в один файл .d.ts. Этот файл можно обрезать, чтобы
исключить объявления, помеченные с помощью тегов TSDoc, таких как @beta "или
@internal.

\- Документация API - Инструмент генерирует JSON-файл «модели документа» для
каждого из ваших проектов. Этот файл JSON содержит извлеченные подписи типов и
комментарии к документам. Сопутствующий инструмент «api-documentmenter» может
использовать эти файлы для создания справочного веб-сайта API или использовать
их в качестве входных данных для пользовательского конвейера документации.