Skip to main content

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

IConfigurationFileOptions interface

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.

export interface IConfigurationFileOptions<TConfigurationFile>


jsonPathMetadata?IJsonPathsMetadata(BETA) (Optional) Use this property to specify how JSON nodes are postprocessed.
jsonSchemaPathstring(BETA) The path to the schema for the configuration file.
projectRelativeFilePathstring(BETA) A project root-relative path to the configuration file that should be loaded.
propertyInheritance?IPropertiesInheritance <TConfigurationFile>(BETA) (Optional) Use this property to control how root-level properties are handled between parent and child configuration files.