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

ProjectConfigurationFile 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 ProjectConfigurationFile<TConfigurationFile> extends ConfigurationFileBase<TConfigurationFile, IProjectConfigurationFileOptions> 

Extends: ConfigurationFileBase<TConfigurationFile, IProjectConfigurationFileOptions>

Constructors

Constructor	Modifiers	Description
(constructor)(options)		(BETA) Constructs a new instance of the ProjectConfigurationFile class

Properties

Property	Modifiers	Type	Description
projectRelativeFilePath	readonly	string	(BETA) A project root-relative path to the configuration file that should be loaded.

Methods

Method	Modifiers	Description
loadConfigurationFileForProject(terminal, projectPath, rigConfig)		(BETA) 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.
loadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig)		(BETA) 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.
tryLoadConfigurationFileForProject(terminal, projectPath, rigConfig)		(BETA) This function is identical to ProjectConfigurationFile.loadConfigurationFileForProject(), except that it returns undefined instead of throwing an error if the configuration file cannot be found.
tryLoadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig)		(BETA) This function is identical to ProjectConfigurationFile.loadConfigurationFileForProjectAsync(), except that it returns undefined instead of throwing an error if the configuration file cannot be found.