Type Alias ErrorHandler

Used to transform normalized errors for one or more keywords into human readable messages.

error describes keywords that failed. success describes what keywords require. Success messages are used to explain failures caused by a subschema passing, such as with not. A handler can have either or both.

type ErrorHandler = {
    error?: (
        normalizedErrors: InstanceOutput,
        instance: JsonNode,
        context: ErrorHandlerContext,
    ) => ErrorObject[];
    success?: (
        normalizedOutput: InstanceOutput,
        instance: JsonNode,
        context: ErrorHandlerContext,
    ) => ErrorObject[];
}

Index

Properties

error? success?

Properties

`Optional`error

error?: (
    normalizedErrors: InstanceOutput,
    instance: JsonNode,
    context: ErrorHandlerContext,
) => ErrorObject[]

`Optional`success

success?: (
    normalizedOutput: InstanceOutput,
    instance: JsonNode,
    context: ErrorHandlerContext,
) => ErrorObject[]