{"library":"rollup-plugin-api-extractor","title":"Rollup API Extractor Plugin","description":"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.","language":"javascript","status":"active","last_verified":"Wed Apr 22","install":{"commands":["npm install rollup-plugin-api-extractor"],"cli":null},"imports":["import { apiExtractor } from 'rollup-plugin-api-extractor';","const { apiExtractor } = require('rollup-plugin-api-extractor');","import { ApiExtractorPluginOptions } from 'rollup-plugin-api-extractor';"],"auth":{"required":false,"env_vars":[]},"quickstart":{"code":"import typescript from '@rollup/plugin-typescript';\nimport { apiExtractor } from 'rollup-plugin-api-extractor';\n\nexport default {\n  input: 'src/index.ts',\n  output: {\n    dir: 'dist',\n    format: 'esm'\n  },\n  plugins: [\n    typescript(),\n    apiExtractor({\n      // Optional: Specify a custom config file path if not at './config/api-extractor.json'\n      // configFile: './api-extractor.json'\n      // Optional: Override config settings directly\n      // configuration: {\n      //   mainEntryPointFilePath: '<projectFolder>/lib/index.d.ts'\n      // }\n    })\n  ]\n};","lang":"javascript","description":"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.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}