Home > @rushstack/heft-config-file > ProjectConfigurationFile > loadConfigurationFileForProjectAsync
ProjectConfigurationFile.loadConfigurationFileForProjectAsync() 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.
Find and return a configuration file for the specified project, automatically resolving extends properties and handling rigged configuration files. Will throw an error if a configuration file cannot be found in the rig or project config folder.
Signature:
loadConfigurationFileForProjectAsync(terminal: ITerminal, projectPath: string, rigConfig?: IRigConfig): Promise<TConfigurationFile>;
Parameters
Parameter | Type | Description |
|---|---|---|
terminal | ||
projectPath | string | |
rigConfig | (Optional) |
Returns:
Promise<TConfigurationFile>