Home > @rushstack/heft-config-file > NonProjectConfigurationFile > loadConfigurationFileAsync

NonProjectConfigurationFile.loadConfigurationFileAsync() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Load the configuration file at the specified absolute path, automatically resolving extends properties. Will throw an error if the file cannot be found.

Signature:

loadConfigurationFileAsync(terminal: ITerminal, filePath: string): Promise<TConfigurationFile>;

Parameters

Parameter	Type	Description
terminal	ITerminal
filePath	string

Returns:

Promise<TConfigurationFile>