API Extractor
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.
Cost / License
- Free
- Open Source
Application type
Platforms
- Mac
- Windows
- Linux
- Self-Hosted
Features
Tags
- typescript
- Documentation
- tsdoc
- Api
- Developer Tools
- Node.js
API Extractor News & Activities
Recent activities
API Extractor information
Developed by
UnknownLicensing
Open Source and Free product.Written in
Alternatives
6 alternatives listedSupported Languages
- English
AlternativeTo Category
DevelopmentGitHub repository
- 6,378 Stars
- 654 Forks
- 982 Open Issues
- Updated
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.