RoadmapShopEvents
Skip to main content

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

ExtractorConfig.loadFileAndPrepare() method

Loads the api-extractor.json config file from the specified file path, and prepares an ExtractorConfig object.

Signature:

static loadFileAndPrepare(configJsonFilePath: string): ExtractorConfig;

Parameters

ParameterTypeDescription
configJsonFilePathstring

Returns:

ExtractorConfig

Remarks

Loads the api-extractor.json config file from the specified file path. If the "extends" field is present, the referenced file(s) will be merged. For any omitted fields, the API Extractor default values are merged.

The result is prepared using ExtractorConfig.prepare().