Registry / devops / rollup-plugin-api-extractor

rollup-plugin-api-extractor

library0.2.5jsnpmunverified

The `rollup-plugin-api-extractor` package provides a Rollup plugin to seamlessly integrate `@microsoft/api-extractor` into TypeScript build workflows. It allows developers to generate and manage high-quality API declaration files (`.d.ts`) and API documentation reports directly within their Rollup build process. As of version 0.2.5, this plugin supports the latest features of API Extractor to enable consistent API surface definition and validation for libraries. It is actively maintained with relatively frequent minor updates since its initial release (0.2.2), making it a reliable choice for projects requiring robust type declaration bundling and API surface control. A key differentiator is its direct, configurable integration with Rollup, avoiding complex manual scripting for API Extractor execution.

devops serialization

npm install rollup-plugin-api-extractor

github ↗package ↗

INSTALL

IMPORT

SIG · ROLLUP-PLUGIN-API-

rollup-plugin-api-extractor

devopsjavascriptv0.2.5

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

apiExtractor

✓ import { apiExtractor } from 'rollup-plugin-api-extractor';

✗ import apiExtractor from 'rollup-plugin-api-extractor';

The `apiExtractor` function is a named export and must be imported using destructuring. This package is typically used in Rollup configuration files which usually support ESM syntax.

apiExtractor (CJS)

✓ const { apiExtractor } = require('rollup-plugin-api-extractor');

✗ const apiExtractor = require('rollup-plugin-api-extractor');

For CommonJS environments (e.g., older Node.js Rollup configs), named exports are accessed via destructuring from the `require` call.

Plugin Options Type

✓ import { ApiExtractorPluginOptions } from 'rollup-plugin-api-extractor';

TypeScript users can import the `ApiExtractorPluginOptions` type for better type checking when configuring the plugin.

This quickstart demonstrates integrating `rollup-plugin-api-extractor` into a basic Rollup configuration for a TypeScript project, bundling `src/index.ts` into ESM format and then processing declarations with API Extractor.

import typescript from '@rollup/plugin-typescript'; import { apiExtractor } from 'rollup-plugin-api-extractor'; export default { input: 'src/index.ts', output: { dir: 'dist', format: 'esm' }, plugins: [ typescript(), apiExtractor({ // Optional: Specify a custom config file path if not at './config/api-extractor.json' // configFile: './api-extractor.json' // Optional: Override config settings directly // configuration: { // mainEntryPointFilePath: '<projectFolder>/lib/index.d.ts' // } }) ] };

Debug

Known issues

gotcha`@microsoft/api-extractor` and `rollup` are peer dependencies of this plugin and must be installed separately in your project.

fix

Run `npm install --save-dev @microsoft/api-extractor rollup` or `yarn add --dev @microsoft/api-extractor rollup`.

affects: >=0.2.2

gotchaFor API Extractor to function correctly, your `tsconfig.json` must have `compilerOptions.declaration` and `compilerOptions.declarationMap` set to `true`.

fix

Ensure `tsconfig.json` includes: `{ "compilerOptions": { "declaration": true, "declarationMap": true } }`.

affects: >=0.2.2

gotchaThe `types` or `typings` field in your `package.json` must accurately point to the main declaration file (`.d.ts`) generated by API Extractor (e.g., `lib/index.d.ts`).

fix

Update `package.json`: `'types': 'path/to/your/main.d.ts'`.

affects: >=0.2.2

gotchaThe `api-extractor.json` configuration file must be initialized and its `mainEntryPointFilePath` property correctly configured to match your `package.json`'s `types` field.

fix

Run `npx api-extractor init` to generate the file, then edit `api-extractor.json` to set `'mainEntryPointFilePath': '<projectFolder>/lib/index.d.ts'` (adjust path as needed).

affects: >=0.2.2

gotchaIf `api-extractor.json` is not located at the default path (`./config/api-extractor.json`), you must explicitly specify its path in the plugin options.

fix

Pass `{ configFile: './path/to/your/api-extractor.json' }` to the `apiExtractor()` plugin call in your `rollup.config.js`.

affects: >=0.2.2

Errors

Common errors & fixes

Error: [@microsoft/api-extractor] The API Extractor configuration file could not be found.

The `api-extractor.json` file is either missing, incorrectly named, or its path is not accessible/specified.

fix

Run `npx api-extractor init` to generate `api-extractor.json` in the default location (`config/`) or provide the correct path via the `configFile` plugin option: `apiExtractor({ configFile: './your-config.json' })`.

TypeError: apiExtractor is not a function

The plugin's named export `apiExtractor` was incorrectly imported as a default export or through an improper CommonJS `require` statement.

fix

Ensure you are using named import syntax: `import { apiExtractor } from 'rollup-plugin-api-extractor';` or for CommonJS: `const { apiExtractor } = require('rollup-plugin-api-extractor');`.

You must install rollup (>=2.63.0) and @microsoft/api-extractor (>=7.19.0) as peer dependencies.

One or both of the required peer dependencies (`rollup` and `@microsoft/api-extractor`) are not installed in your project.

fix

Install the missing peer dependencies using `npm install --save-dev rollup @microsoft/api-extractor` or `yarn add --dev rollup @microsoft/api-extractor`.

Upgrade

Version history

0.2.5latest on npm

Audit

Dependencies

@microsoft/api-extractorrequiredRuntime dependency for performing API extraction and declaration bundling.

rolluprequiredPeer dependency as the plugin integrates directly with the Rollup build system.

tsliboptionalCommon TypeScript runtime library, often implicitly required by compiled TypeScript output.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/blacktau/rollup-plugin-api-extractor ↗

packagehttps://www.npmjs.com/package/rollup-plugin-api-extractor ↗