API Extractor Alternatives

API Extractor

API Extractor helps TypeScript developers manage the API surface for their library. It is distributed as an NPM package "@microsoft/api-extractor". It produces three different output types:

- API Report - API Extractor can trace all exports from your project’s main entry point and generate a report to be used as the basis for an API review workflow.

- .d.ts Rollups - Similar to how Webpack can “roll up” all your JavaScript files into a single bundle for distribution, API Extractor can roll up your TypeScript declarations into a single .d.ts file. This file can be trimmed to exclude declarations marked using TSDoc tags such as @beta" or @internal.

- API Documentation - The tool generates a “doc model” JSON file for each of your projects. This JSON file contains the extracted type signatures and doc comments. The "api-documenter" companion tool can use these files to generate an API reference website, or you can use them as inputs for a custom documentation pipeline.