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.

Signature:

export interface IConfigurationFileOptions<TConfigurationFile> 

Properties

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