zod-validation-error

Features

Installation

Requirements

Quick start

Motivation

Example

Input (from Zod)

Output

API

ValidationError

Arguments

Example 1: construct new ValidationError with `message`

Example 2: construct new ValidationError with `message` and `options.cause`

createMessageBuilder

Arguments

Example

errorMap

Example

isValidationError

Arguments

Example

isValidationErrorLike

Arguments

Example

isZodErrorLike

Arguments

Example

fromError

Arguments

Notes

fromZodIssue

Arguments

Notes

fromZodError

Arguments

Notes

toValidationError

Example using fp-ts

MessageBuilder

Example

FAQ

How to distinguish between errors

Example

How to use `ValidationError` outside `zod`

Example 1: passing custom message

Example 2: passing custom message and original error as cause

How to use `ValidationError` with custom "error map"

Example 1: produce user-friendly error messages using the `errorMap` property

Example 2: extra customization using `fromZodIssue`

How to use `zod-validation-error` with `react-hook-form`?

Does `zod-validation-error` support CommonJS

Example

Contribute

We are hiring

License