Home > @microsoft/node-core-library > IJsonSchemaValidateOptions > customErrorHeader

IJsonSchemaValidateOptions.customErrorHeader property

A custom header that will be used to report schema errors.

Signature:

customErrorHeader?: string;

Remarks

If omitted, the default header is “JSON validation failed:”. The error message starts with the header, followed by the full input filename, followed by the z-schema error tree. If you wish to customize all aspects of the error message, use JsonFile.loadAndValidateWithCallback() or JsonSchema.validateObjectWithCallback().