Home > @rushstack/heft-config-file

heft-config-file package

A library for loading config files for use with the Heft build system.

Classes

Class	Description
NonProjectConfigurationFile	(BETA)
ProjectConfigurationFile	(BETA)

Abstract Classes

Abstract Class	Description
ConfigurationFileBase	(BETA)

Interfaces

Interface	Description
IConfigurationFileOptionsBase	(BETA)
ICustomJsonPathMetadata	(BETA) Used to specify how node(s) in a JSON object should be processed after being loaded.
ICustomPropertyInheritance	(BETA)
IJsonPathMetadataResolverOptions	(BETA) Options provided to the custom resolver specified in ICustomJsonPathMetadata.
IJsonPathsMetadata	(BETA) Keys in this object are JSONPaths https://jsonpath.com/, and values are objects that describe how node(s) selected by the JSONPath are processed after loading.
INonCustomJsonPathMetadata	(BETA) Used to specify how node(s) in a JSON object should be processed after being loaded.
IOriginalValueOptions	(BETA)
IProjectConfigurationFileOptions	(BETA)
IPropertyInheritance	(BETA)
IPropertyInheritanceDefaults	(BETA)

Namespaces

Namespace	Description
InheritanceType	(BETA)
PathResolutionMethod	(BETA)
TestUtilities

Variables

Variable	Description
ConfigurationFile	(BETA)
InheritanceType	(BETA) The set of possible mechanisms for merging properties from parent configuration files. If a child configuration file sets a property value to null, that will always delete the value specified in the parent configuration file, regardless of the inheritance type.
PathResolutionMethod	(BETA) The set of possible resolution methods for fields that refer to paths.

Type Aliases

Type Alias	Description
ConfigurationFile	(BETA)
CustomValidationFunction	(BETA) A function to invoke after schema validation to validate the configuration file. If this function returns any value other than true, the configuration file API will throw an error indicating that custom validation failed. If the function wishes to provide its own error message, it may use any combination of the terminal and throwing its own error.
IConfigurationFileOptions	(BETA)
IConfigurationFileOptionsWithJsonSchemaFilePath	(BETA)
IConfigurationFileOptionsWithJsonSchemaObject	(BETA)
IJsonPathMetadata	(BETA)
InheritanceType	(BETA)
IOnConfigurationFileNotFoundCallback	(BETA) Callback that returns a fallback configuration file path if the original configuration file was not found.
IProjectConfigurationFileSpecification	(BETA) Alias for the constructor type for ProjectConfigurationFile.
IPropertiesInheritance	(BETA)
PathResolutionMethod	(BETA)
PropertyInheritanceCustomFunction	(BETA)