Capture the contracts in a concise report designed to facilitate review.Detect a project's exported API surface.

It is invoked at build time by your toolchain and leverages the TypeScript compiler engine to:

What tool to use?ĪPI Extractor provides an integrated, professional-quality solution for all these problems.

Now that your library has shipped, it's time to set up a nicely formatted API reference. Online documentation: You have faithfully annotated each TypeScript member with nice TSDoc descriptions. Developers building a production project don't want to see a bunch of internal and beta members in their VS Code IntelliSense! *.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. But how to indicate this to your consumers? (And how to detect scoping mistakes? A public function should never return a beta result.) 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. How do we avoid this in the future?Īlpha/Beta graduation: You want to release previews of new APIs that are not ready for prime time yet. When you try to remove it, consumers complain that they're using it. How to avoid these oversights?Īccidental exports: You meant for your DrawHelper class to be kept internal, but one day you realize it's being exported. 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. 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. That would focus attention in the right place. 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. To address this, you boldly propose that every awesome-widgets pull request must be approved by an experienced developer from your team. As developers start to depend on your library, you may encounter issues such as.Īccidental breaks: People keep reporting that their code won't compile after a supposedly 'minor' update. Suppose for example that your company has published an NPM package called ' awesome-widgets' that exports many classes and interfaces. Extractor helps you build better TypeScript library packages.

I xtractor