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

NonProjectConfigurationFile class

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.

Signature:

export declare class NonProjectConfigurationFile<TConfigurationFile> extends ConfigurationFileBase<TConfigurationFile, {}> 

Extends: ConfigurationFileBase<TConfigurationFile, {}>

Methods

Method	Modifiers	Description
loadConfigurationFile(terminal, filePath)		(BETA) Load the configuration file at the specified absolute path, automatically resolving extends properties. Will throw an error if the file cannot be found.
loadConfigurationFileAsync(terminal, filePath)		(BETA) Load the configuration file at the specified absolute path, automatically resolving extends properties. Will throw an error if the file cannot be found.
tryLoadConfigurationFile(terminal, filePath)		(BETA) This function is identical to NonProjectConfigurationFile.loadConfigurationFile(), except that it returns undefined instead of throwing an error if the configuration file cannot be found.
tryLoadConfigurationFileAsync(terminal, filePath)		(BETA) This function is identical to NonProjectConfigurationFile.loadConfigurationFileAsync(), except that it returns undefined instead of throwing an error if the configuration file cannot be found.