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

ExtractorConfig.loadFile() method

Performs only the first half of ExtractorConfig.loadFileAndPrepare(), providing an opportunity to modify the object before it is passed to ExtractorConfig.prepare().

Signature:

static loadFile(jsonFilePath: string): IConfigFile;

Parameters

Parameter Type Description
jsonFilePath string  

Returns:

IConfigFile

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.