Rush StackShopBlogEvents
Skip to main content

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

ConfigurationFileBase 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 abstract class ConfigurationFileBase<TConfigurationFile, TExtraOptions extends {}> 

Constructors

Constructor

Modifiers

Description

(constructor)(options)

(BETA) Constructs a new instance of the ConfigurationFileBase class

Methods

Method

Modifiers

Description

_loadConfigurationFileInnerWithCache(terminal, resolvedConfigurationFilePath, projectFolderPath, onConfigurationFileNotFound)

protected

(BETA)

_loadConfigurationFileInnerWithCacheAsync(terminal, resolvedConfigurationFilePath, projectFolderPath, onFileNotFound)

protected

(BETA)

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.

getSchemaPropertyOriginalValue(obj)

(BETA) Get the original value of the $schema property from the original configuration file, it one was present.