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`

createErrorMap

Arguments

createErrorMap Options

Example

createMessageBuilder

Arguments

createMessageBuilder Options

Example

isValidationError

Arguments

Example

isValidationErrorLike

Arguments

Example

isZodErrorLike

Arguments

Example

fromError

Arguments

Notes

fromZodIssue

Arguments

Notes

fromZodError

Arguments

Notes

toValidationError

Example using fp-ts

FAQ

What is the difference between zod-validation-error and zod's own prettifyError?

Do I need to use `zod-validation-error`'s error map?

Where can I see how `zod-validation-error`'s error map formatting works?

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: produce user-friendly error messages using the `customError` property

Does `zod-validation-error` support CommonJS

Example

Contribute

We are hiring

License