Class ZodError<T>

Type Parameters

  • T = any

Hierarchy

  • Error
    • ZodError

Constructors

constructor

Properties

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

Accessors

errors formErrors isEmpty message

Methods

flatten format toString assert captureStackTrace

Constructors

constructor

  • new ZodError<T>(issues): ZodError<T>

  • Type Parameters

    • T = any

    Parameters

    Returns ZodError<T>

Properties

addIssue

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

addIssues

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

Optionalcause

cause?: unknown

issues

issues: ZodIssue[]

name

name: string

Optionalstack

stack?: string

Staticcreate

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

Static OptionalprepareStackTrace

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

Optional override for formatting stack traces

See

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

StaticstackTraceLimit

stackTraceLimit: number

Accessors

errors

  • get errors(): ZodIssue[]

  • Returns ZodIssue[]

formErrors

isEmpty

  • get isEmpty(): boolean

  • Returns boolean

message

  • get message(): string

  • Returns string

Methods

flatten

format

toString

  • toString(): string

  • Returns a string representation of an object.

    Returns string

Staticassert

  • assert(value): asserts value is ZodError<any>

  • Parameters

    • value: unknown

    Returns asserts value is ZodError<any>

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods