API Extractor icon
API Extractor icon

API Extractor

 Like

API Extractor helps you write better TypeScript libraries: It analyzes your exported type signatures and (1) produces an API documentation website, (2) generates a .d.ts "rollup" file, and (3) creates an API report to facilitate PR reviews.

API Extractor screenshot 1

License model

  • FreeOpen Source

Application type

Platforms

  • Mac
  • Windows
  • Linux
  • Self-Hosted
  No rating
0likes
0comments
0news articles

Features

Suggest and vote on features
No features, maybe you want to suggest one?

API Extractor News & Activities

Highlights All activities

Recent activities

No activities found.

API Extractor information

  • Developed by

    Unknown
  • Licensing

    Open Source and Free product.
  • Written in

  • Alternatives

    6 alternatives listed
  • Supported Languages

    • English

AlternativeTo Category

Development

GitHub repository

  •  6,163 Stars
  •  623 Forks
  •  943 Open Issues
  •   Updated May 15, 2025 
View on GitHub

Popular alternatives

View all

Our users have written 0 comments and reviews about API Extractor, and it has gotten 0 likes

API Extractor was added to AlternativeTo by octogonz on Apr 18, 2019 and this page was last updated Sep 12, 2020.
No comments or reviews, maybe you want to be first?
Post comment/review

What is 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.

Official Links