0
API Extractor
API Extractor lo ayuda a escribir mejores bibliotecas TypeScript: analiza sus firmas de tipo exportadas y (1) produce un sitio web de documentación API, (2) genera un archivo "rollup" .d.ts y (3) crea un informe API para facilitar la RPcomentarios
- Gratis
- Self-Hosted
- Windows
- Mac
- Linux
API Extractor ayuda a los desarrolladores de TypeScript a administrar la superficie API para su biblioteca.Se distribuye como un paquete NPM "@ microsoft / api-extractor".Produce tres tipos de salida diferentes: - Informe API - API Extractor puede rastrear todas las exportaciones desde el punto de entrada principal de su proyecto y generar un informe que se utilizará como base para un flujo de trabajo de revisión de API.- .d.ts Rollups: de forma similar a cómo Webpack puede "acumular" todos sus archivos JavaScript en un solo paquete para su distribución, API Extractor puede acumular sus declaraciones de TypeScript en un único archivo .d.ts.Este archivo se puede recortar para excluir declaraciones marcadas con etiquetas TSDoc como @beta "o @internal. - Documentación API - La herramienta genera un archivo JSON de" modelo de documentación "para cada uno de sus proyectos. Este archivo JSON contiene las firmas de tipo extraídas ycomentarios del documento. La herramienta complementaria "api-documenter" puede usar estos archivos para generar un sitio web de referencia de API, o puede usarlos como entradas para una canalización de documentación personalizada.
api-extractor