Interface $ZodCheckDef

interface $ZodCheckDef {
    abort?: boolean;
    check: string;
    error?: $ZodErrorMap<never>;
    when?: (payload: ParsePayload) => boolean;
}

Properties

abort?: boolean

If true, no later checks will be executed if this check fails. Default false.

check: string

error?: $ZodErrorMap<never>

when?: (payload: ParsePayload) => boolean

If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).