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

IConfigurationFileOptionsBase interface

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 interface IConfigurationFileOptionsBase<TConfigurationFile> 

Properties

Property	Modifiers	Type	Description
customValidationFunction?		CustomValidationFunction<TConfigurationFile>	(BETA) (Optional) Use this property if you need to validate the configuration file in ways beyond what JSON schema can handle. This function will be invoked after JSON schema validation. If the file is valid, this function should return true, otherwise ConfigurationFile will throw an error indicating that custom validation failed. To suppress this error, the function may itself choose to throw.
jsonPathMetadata?		IJsonPathsMetadata<TConfigurationFile>	(BETA) (Optional) Use this property to specify how JSON nodes are postprocessed.
propertyInheritance?		IPropertiesInheritance<TConfigurationFile>	(BETA) (Optional) Use this property to control how root-level properties are handled between parent and child configuration files.
propertyInheritanceDefaults?		IPropertyInheritanceDefaults	(BETA) (Optional) Use this property to control how specific property types are handled between parent and child configuration files.