Home > @rushstack/heft-config-file > ConfigurationFile
ConfigurationFile class
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.
Signature:
export declare class ConfigurationFile<TConfigurationFile>
Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(options) | (BETA) Constructs a new instance of the ConfigurationFile class |
Methods
| Method | Modifiers | Description |
|---|---|---|
| getObjectSourceFilePath(obj) | (BETA) Get the path to the source file that the referenced property was originally loaded from. | |
| getPropertyOriginalValue(options) | (BETA) Get the value of the specified property on the specified object that was originally loaded from a configuration file. | |
| loadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig) | (BETA) | |
| tryLoadConfigurationFileForProjectAsync(terminal, projectPath, rigConfig) | (BETA) 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. |