4.56 kBMarkdownView Raw
1# @microsoft/api-extractor
4![API Extractor](https://github.com/microsoft/rushstack/raw/main/common/wiki-images/api-extractor-title.png?raw=true)
5<br />
6&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; https://api-extractor.com/
8<!-- ------------------------------------------------------------------ -->
9<!-- Text below this line should stay in sync with the web site content -->
10<!-- ------------------------------------------------------------------ -->
12**API Extractor** helps you build better [TypeScript](https://www.typescriptlang.org/) library packages. Suppose for example that your company has published an NPM package called "**awesome-widgets**" that exports many classes and interfaces. As developers start to depend on your library, you may encounter issues such as...
14- **Accidental breaks:** People keep reporting that their code won't compile after a supposedly "minor" update. To address this, you boldly propose that every **awesome-widgets** pull request must be approved by an experienced developer from your team. But that proves unrealistic -- nobody has time to look at every single PR! What you really need is a way to detect PRs that change API contracts, and flag them for review. That would focus attention in the right place... but how to do that?
16- **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 developer tries to call that function, they discover that there's no way to specify the `DrawStyle`. How to avoid these oversights?
18- **Accidental exports:** You meant for your `DrawHelper` class to be kept internal, but one day you realize it's being exported. When you try to remove it, consumers complain that they're using it. How do we avoid this in the future?
20- **Alpha/Beta graduation:** You want to release previews of new APIs that are not ready for prime time yet. But if you did a major SemVer bump every time these definitions evolve, the villagers would be after you with torches and pitchforks! A better approach is to designate certain classes/members as **alpha** quality, then promote them to **beta** and finally to **public** as they mature. But how to indicate this to your consumers? (And how to detect scoping mistakes? A **public** function should never return a **beta** result.)
22- **\*.d.ts rollup:** You webpacked your library into a nice **\*.js** bundle file -- so why ship your typings as a messy tree of **lib/\*.d.ts** files full of private definitions? Can't we consolidate them into a tidy **\*.d.ts** rollup file? And if you publish internal/beta/public releases, each release type should get its own **\*.d.ts** file with appropriate trimming. Developers building a production project don't want to see a bunch of **internal** and **beta** members in their VS Code IntelliSense!
24- **Online documentation:** You have faithfully annotated each TypeScript member with nice [TSDoc](https://github.com/microsoft/tsdoc) descriptions. Now that your library has shipped, it's time to set up [a nicely formatted](https://docs.microsoft.com/en-us/javascript/api/sp-http) API reference. What tool to use?
26**API Extractor** provides an integrated, professional-quality solution for all these problems. It is invoked at build time by your toolchain and leverages the TypeScript compiler engine to:
28- Detect a project's exported API surface
29- Capture the contracts in a concise report designed to facilitate review
30- Warn about common mistakes (e.g. missing exports, inconsistent visibility, etc.)
31- Generate \*.d.ts rollups with trimming according to release type
32- Output API documentation in a portable format that's easy to integrate with your content pipeline
34Best of all, **API Extractor** is free and open source. Join the community and create a pull request!
36<!-- ------------------------------------------------------------------ -->
37<!-- Text above this line should stay in sync with the web site content -->
38<!-- ------------------------------------------------------------------ -->
40## Getting Started
42For more details and support resources, please visit: https://api-extractor.com/
44## Links
46- [CHANGELOG.md](
47 https://github.com/microsoft/rushstack/blob/main/apps/api-extractor/CHANGELOG.md) - Find
48 out what's new in the latest version
49- [API Reference](https://rushstack.io/pages/api/api-extractor/)
51API Extractor is part of the [Rush Stack](https://rushstack.io/) family of projects.