rollup-plugin-api-extractor/dist/index.d.ts

A rollupjs plugin for integrating with @microsoft/api-extractor

import { PluginImpl } from 'rollup';
import { IConfigFile } from '@microsoft/api-extractor';
/**
 * Configuration options for the RollupJs ApiExtractor plugin
 * @public
 */
export interface ApiExtractorPluginOptions {
    /**
     * The path to the api extractor configuration file. defaults to ./config/api-extractor.json
     */
    configFile?: string;
    /**
     * Configuration overrides for the the api extractor configuration.
     * if no config file is specified and the default file does not exist all mandatory configuration sections need to be supplied here.
     */
    configuration?: Partial<IConfigFile>;
    /**
     * Indicates that API Extractor is running as part of a local build, e.g. on a developer's machine
     */
    local?: boolean;
    /**
     * Show additional api-extractor messages in the output
     */
    verbose?: boolean;
    /**
     * Show diagnostic messages used for troubleshooting problems with API Extractor.
     */
    diagnostics?: boolean;
    /**
     * Override the typescript version that api-extractor uses.
     * @see [api-extractor documentation for more information])(https://api-extractor.com/pages/commands/api-extractor_run/)
     */
    typescriptFolder?: string;
    /**
     * when true deletes the left over .d.ts files following the rollup. defaults to true.
     */
    cleanUpRollup?: boolean;
}
/**
 * adds \@microsoft/api-extractor to you rollupjs pipeline.
 * @public
 * @param pluginOptions - The configuration options for the rollupjs plugin {@link ApiExtractorPluginOptions}
 * @returns the api-extractor plugin function
 */
export declare const apiExtractor: PluginImpl<ApiExtractorPluginOptions>;