NPM Package API Surface Extractor

NPM Package API Surface Extractor

Extracts and documents public API surfaces from NPM packages using TypeScript Compiler API (ts.createProgram) and API Extractor from @microsoft/api-extractor. Generates .api.md report files and .d.ts rollups.

Prerequisites

Node.js, TypeScript

Installation

Requirements and caveats from upstream:

• Missing exports: Suppose the awesome-widgets package exports an API function AwesomeButton.draw() that requires a parameter of type DrawStyle , but you forgot to export this enum. Things seem fine at first, but when a...

Basic usage or getting-started notes:

• API Extractor helps you build better TypeScript library packages. Suppose for example that your company has published an NPM package called “ awesome-widgets ” that exports many classes and interfaces. As developers s...

• Source: https://api-extractor.com/

Documentation

• https://api-extractor.com/

Source

• Agent Skill Exchange