title: Core.z. Zod Error
A2A Node SDK - v0.1.0 / Modules / Core / z / ZodError
Class: ZodError<T>
Type parameters
| Name | Type |
|---|---|
T | any |
Hierarchy
-
Error↳
ZodError
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new ZodError<T>(issues): ZodError<T>
Type parameters
| Name | Type |
|---|---|
T | any |
Parameters
| Name | Type |
|---|---|
issues | ZodIssue[] |
Returns
ZodError<T>
Overrides
Error.constructor
Properties
addIssue
• addIssue: (sub: ZodIssue) => void
Type declaration
▸ (sub): void
Parameters
| Name | Type |
|---|---|
sub | ZodIssue |
Returns
void
addIssues
• addIssues: (subs?: ZodIssue[]) => void
Type declaration
▸ (subs?): void
Parameters
| Name | Type |
|---|---|
subs? | ZodIssue[] |
Returns
void
create
▪ Static create: (issues: ZodIssue[]) => ZodError<any>
Type declaration
▸ (issues): ZodError<any>
Parameters
| Name | Type |
|---|---|
issues | ZodIssue[] |
Returns
ZodError<any>
issues
• issues: ZodIssue[]
name
• name: string
Inherited from
Error.name
stack
• Optional stack: string
Inherited from
Error.stack
stackTraceLimit
▪ Static stackTraceLimit: number
The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).
The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.
If set to a non-number value, or set to a negative number, stack traces will not capture any frames.
Inherited from
Error.stackTraceLimit
Accessors
errors
• get errors(): ZodIssue[]
Returns
ZodIssue[]
formErrors
• get formErrors(): typeToFlattenedError<T, string>
Returns
typeToFlattenedError<T, string>
isEmpty
• get isEmpty(): boolean
Returns
boolean
message
• get message(): string
Returns
string
Overrides
Error.message
Methods
assert
▸ assert(value): asserts value is ZodError<any>
Parameters
| Name | Type |
|---|---|
value | unknown |
Returns
asserts value is ZodError<any>
captureStackTrace
▸ captureStackTrace(targetObject, constructorOpt?): void
Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack; // Similar to `new Error().stack`The first line of the trace will be prefixed with
${myObject.name}: ${myObject.message}.
The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.
The constructorOpt argument is useful for hiding implementation
details of error generation from the user. For instance:
function a() {
b();
}
function b() {
c();
}
function c() {
// Create an error without stack trace to avoid calculating the stack trace twice.
const { stackTraceLimit } = Error;
Error.stackTraceLimit = 0;
const error = new Error();
Error.stackTraceLimit = stackTraceLimit;
// Capture the stack trace above function b
Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
throw error;
}
a();Parameters
| Name | Type |
|---|---|
targetObject | object |
constructorOpt? | Function |
Returns
void
Inherited from
Error.captureStackTrace
flatten
▸ flatten(): typeToFlattenedError<T, string>
Returns
typeToFlattenedError<T, string>
▸ flatten<U>(mapper?): typeToFlattenedError<T, U>
Type parameters
| Name |
|---|
U |
Parameters
| Name | Type |
|---|---|
mapper? | (issue: ZodIssue) => U |
Returns
typeToFlattenedError<T, U>
format
▸ format(): ZodFormattedError<T, string>
Returns
ZodFormattedError<T, string>
▸ format<U>(mapper): ZodFormattedError<T, U>
Type parameters
| Name |
|---|
U |
Parameters
| Name | Type |
|---|---|
mapper | (issue: ZodIssue) => U |
Returns
ZodFormattedError<T, U>
prepareStackTrace
▸ prepareStackTrace(err, stackTraces): any
Parameters
| Name | Type |
|---|---|
err | Error |
stackTraces | CallSite[] |
Returns
any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Inherited from
Error.prepareStackTrace
toString
▸ toString(): string
Returns
string