Home > @microsoft/api-extractor > ExtractorConfig > prepare

ExtractorConfig.prepare() method

Prepares an ExtractorConfig object using a configuration that is provided as a runtime object, rather than reading it from disk. This allows configurations to be constructed programmatically, loaded from an alternate source, and/or customized after loading.

Signature:

static prepare(options: IExtractorConfigPrepareOptions): ExtractorConfig;

Parameters

Parameter Type Description
options IExtractorConfigPrepareOptions  

Returns:

ExtractorConfig