Home > @rushstack/heft-config-file > ConfigurationFile > tryLoadConfigurationFileForProjectAsync

ConfigurationFile.tryLoadConfigurationFileForProjectAsync() method

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

This function is identical to ConfigurationFile.loadConfigurationFileForProjectAsync(), except that a preliminary file existence check is performed and this function returns undefined if the configuration file doesn’t exist.

Signature:

tryLoadConfigurationFileForProjectAsync(terminal: Terminal, projectPath: string, rigConfig?: RigConfig): Promise<TConfigurationFile | undefined>;

Parameters

Parameter Type Description
terminal Terminal  
projectPath string  
rigConfig RigConfig  

Returns:

Promise<TConfigurationFile | undefined>