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

Constructors

constructor

new ZodError<T>(issues): ZodError<T>
Type Parameters
- T = any
Parameters
- issues: ZodIssue[]
Returns ZodError<T>
Overrides Error.constructor
- Defined in node_modules/zod/lib/ZodError.d.ts:138

Properties

addIssue

addIssue: ((sub) => void)

Type declaration

- (sub): void
- Parameters
  - sub: ZodIssue
  Returns void

addIssues

addIssues: ((subs?) => void)

Type declaration

- (subs?): void
- Parameters
  - Optional subs: ZodIssue[]
  Returns void

`Optional` cause

cause?: unknown

issues

issues: ZodIssue[]

name

name: string

`Optional` stack

stack?: string

`Static` create

create: ((issues) => ZodError<any>)

Type declaration

- (issues): ZodError<any>
- Parameters
  - issues: ZodIssue[]
  Returns ZodError<any>

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

Type declaration

- (err, stackTraces): any
- Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

See

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

`Static` stackTraceLimit

stackTraceLimit: number

Accessors

errors

get errors(): ZodIssue[]
Returns ZodIssue[]
- Defined in node_modules/zod/lib/ZodError.d.ts:137

formErrors

get formErrors(): typeToFlattenedError<T, string>
Returns typeToFlattenedError<T, string>
- Defined in node_modules/zod/lib/ZodError.d.ts:149

isEmpty

get isEmpty(): boolean
Returns boolean
- Defined in node_modules/zod/lib/ZodError.d.ts:144

message

get message(): string
Returns string
Overrides Error.message
- Defined in node_modules/zod/lib/ZodError.d.ts:143

Methods

flatten

flatten(): typeToFlattenedError<T, string>
Returns typeToFlattenedError<T, string>
- Defined in node_modules/zod/lib/ZodError.d.ts:147
flatten<U>(mapper?): typeToFlattenedError<T, U>
Type Parameters
- U
Parameters
- Optional mapper: ((issue) => U)
  - - (issue): U
    - Parameters
      issue: ZodIssue
      Returns U
Returns typeToFlattenedError<T, U>
- Defined in node_modules/zod/lib/ZodError.d.ts:148

format

format(): ZodFormattedError<T, string>
Returns ZodFormattedError<T, string>
- Defined in node_modules/zod/lib/ZodError.d.ts:139
format<U>(mapper): ZodFormattedError<T, U>
Type Parameters
- U
Parameters
- mapper: ((issue) => U)
  - - (issue): U
    - Parameters
      issue: ZodIssue
      Returns U
Returns ZodFormattedError<T, U>
- Defined in node_modules/zod/lib/ZodError.d.ts:140

toString

toString(): string
Returns string
- Defined in node_modules/zod/lib/ZodError.d.ts:142

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:21

Generated using TypeDoc