API Extractor

API Extractor

O API Extractor ajuda a escrever melhores bibliotecas TypeScript: analisa suas assinaturas de tipo exportadas e (1) produz um site de documentação da API, (2) gera um arquivo "rollup" .d.ts e (3) cria um relatório da API para facilitar o PRavaliações.
O Extrator de API ajuda os desenvolvedores de TypeScript a gerenciar a superfície da API para sua biblioteca.É distribuído como um pacote NPM "@ microsoft / api-extractor".Ele produz três tipos diferentes de saída: - Relatório da API - O API Extractor pode rastrear todas as exportações do ponto de entrada principal do seu projeto e gerar um relatório para ser usado como base para um fluxo de trabalho de revisão da API.- Rollups .d.ts - Similar ao modo como o Webpack pode "reunir" todos os seus arquivos JavaScript em um único pacote para distribuição, o API Extractor pode reunir suas declarações TypeScript em um único arquivo .d.ts.Esse arquivo pode ser aparado para excluir declarações marcadas usando tags TSDoc, como @beta "ou @internal. - Documentação da API - A ferramenta gera um arquivo JSON" modelo de documento "para cada um de seus projetos. Esse arquivo JSON contém as assinaturas de tipo extraídas eA ferramenta complementar "api-documenter" pode usar esses arquivos para gerar um site de referência da API ou você pode usá-los como entradas para um pipeline de documentação personalizado.
api-extractor

Local na rede Internet:

Recursos

Categorias

Alternativas ao API Extractor para Self-Hosted com licença comercial