RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor > Extractor

Extractor class

The starting point for invoking the API Extractor tool.

Signature:

export declare class Extractor 

Properties

PropertyModifiersTypeDescription
packageName

readonly

static

stringReturns the package name of the API Extractor NPM package.
version

readonly

static

stringReturns the version number of the API Extractor NPM package.

Methods

MethodModifiersDescription
invoke(extractorConfig, options)staticInvoke API Extractor using an already prepared ExtractorConfig object.
loadConfigAndInvoke(configFilePath, options)staticLoad the api-extractor.json config file from the specified path, and then invoke API Extractor.