RoadmapShopEvents
Skip to main content

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

ConstructorModifiersDescription
(constructor)(options)(BETA) Constructs a new instance of the ConfigurationFile class

Properties

PropertyModifiersTypeDescription
projectRelativeFilePathstring(BETA) A project root-relative path to the configuration file that should be loaded.

Methods

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