Class ZodError<T>

Type Parameters

T = any

Hierarchy

Error
- ZodError

Index

Constructors

Properties

addIssue addIssues cause? issues name stack? create prepareStackTrace? stackTraceLimit

Accessors

errors formErrors isEmpty message

Methods

flatten format toString captureStackTrace isError

Constructors

constructor

new ZodError<T = any>(issues: Zod.ZodIssue[]): Zod.ZodError<T>
Type Parameters
- T = any
Parameters
- issues: Zod.ZodIssue[]
Returns Zod.ZodError<T>
Overrides Error.constructor

Properties

addIssue

addIssue: (sub: Zod.ZodIssue) => void

addIssues

addIssues: (subs?: Zod.ZodIssue[]) => void

`Optional`cause

cause?: unknown

issues

issues: Zod.ZodIssue[]

name

name: string

`Optional`stack

stack?: string

`Static`create

create: (issues: Zod.ZodIssue[]) => Zod.ZodError<any>

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

`Static`stackTraceLimit

stackTraceLimit: number

Accessors

errors

get errors(): Zod.ZodIssue[]
Returns Zod.ZodIssue[]

formErrors

get formErrors(): Zod.typeToFlattenedError<T, string>
Returns Zod.typeToFlattenedError<T, string>

isEmpty

get isEmpty(): boolean
Returns boolean

message

get message(): string
Returns string
Overrides Error.message

Methods

flatten

flatten(): Zod.typeToFlattenedError<T>
Returns Zod.typeToFlattenedError<T>
flatten<U>(mapper?: (issue: Zod.ZodIssue) => U): Zod.typeToFlattenedError<T, U>
Type Parameters
- U
Parameters
- Optionalmapper: (issue: Zod.ZodIssue) => U
Returns Zod.typeToFlattenedError<T, U>

format

format(): Zod.ZodFormattedError<T>
Returns Zod.ZodFormattedError<T>
format<U>(mapper: (issue: Zod.ZodIssue) => U): Zod.ZodFormattedError<T, U>
Type Parameters
- U
Parameters
- mapper: (issue: Zod.ZodIssue) => U
Returns Zod.ZodFormattedError<T, U>

toString

toString(): string
Returns a string representation of an object.

Returns string

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace

`Static`isError

isError(error: unknown): error is Error
Indicates whether the argument provided is a built-in Error instance or not.
Parameters
- error: unknown
Returns error is Error
Inherited from Error.isError