Home > @microsoft/api-extractor > Extractor

Extractor class

The starting point for invoking the API Extractor tool.

Signature:

export declare class Extractor 

Properties

Property	Modifiers	Type	Description
packageName	static readonly	string	Returns the package name of the API Extractor NPM package.
version	static readonly	string	Returns the version number of the API Extractor NPM package.

Methods

Method	Modifiers	Description
invoke(extractorConfig, options)	static	Invoke API Extractor using an already prepared ExtractorConfig object.
loadConfigAndInvoke(configFilePath, options)	static	Load the api-extractor.json config file from the specified path, and then invoke API Extractor.