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

IConfigurationFileOptionsBase.customValidationFunction property

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.

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.

Signature:

customValidationFunction?: CustomValidationFunction<TConfigurationFile>;