title: Core.z. Zod Any

A2A Node SDK - v0.1.0 / Modules / Core / z / ZodAny

Class: ZodAny

Core.z.ZodAny

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new ZodAny(def): ZodAny

Parameters

NameType
defZodAnyDef

Returns

ZodAny

Inherited from

ZodType.constructor

Properties

_any

_any: true


_def

Readonly _def: ZodAnyDef

Inherited from

ZodType._def


_input

Readonly _input: any

Inherited from

ZodType._input


_output

Readonly _output: any

Inherited from

ZodType._output


_type

Readonly _type: any

Inherited from

ZodType._type


create

Static create: (params?: RawCreateParams) => ZodAny

Type declaration

▸ (params?): ZodAny

Parameters
NameType
params?RawCreateParams
Returns

ZodAny


spa

spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<any, any>>

Alias of safeParseAsync

Type declaration

▸ (data, params?): Promise<SafeParseReturnType<any, any>>

Parameters
NameType
dataunknown
params?InexactPartial<ParseParams>
Returns

Promise<SafeParseReturnType<any, any>>

Inherited from

ZodType.spa


~standard

~standard: Props<any, any>

Inherited from

ZodType.~standard

Accessors

description

get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

Methods

_getOrReturnCtx

_getOrReturnCtx(input, ctx?): ParseContext

Parameters

NameType
inputParseInput
ctx?ParseContext

Returns

ParseContext

Inherited from

ZodType._getOrReturnCtx


_getType

_getType(input): string

Parameters

NameType
inputParseInput

Returns

string

Inherited from

ZodType._getType


_parse

_parse(input): ParseReturnType<any>

Parameters

NameType
inputParseInput

Returns

ParseReturnType<any>

Overrides

ZodType._parse


_parseAsync

_parseAsync(input): AsyncParseReturnType<any>

Parameters

NameType
inputParseInput

Returns

AsyncParseReturnType<any>

Inherited from

ZodType._parseAsync


_parseSync

_parseSync(input): SyncParseReturnType<any>

Parameters

NameType
inputParseInput

Returns

SyncParseReturnType<any>

Inherited from

ZodType._parseSync


_processInputParams

_processInputParams(input): Object

Parameters

NameType
inputParseInput

Returns

Object

NameType
ctxParseContext
statusParseStatus

Inherited from

ZodType._processInputParams


_refinement

_refinement(refinement): ZodEffects<ZodAny, any, any>

Parameters

NameType
refinement(arg: any, ctx: RefinementCtx) => any

Returns

ZodEffects<ZodAny, any, any>

Inherited from

ZodType._refinement


and

and<T>(incoming): ZodIntersection<ZodAny, T>

Type parameters

NameType
Textends ZodTypeAny

Parameters

NameType
incomingT

Returns

ZodIntersection<ZodAny, T>

Inherited from

ZodType.and


array

array(): ZodArray<ZodAny, "many">

Returns

ZodArray<ZodAny, "many">

Inherited from

ZodType.array


brand

brand<B>(brand?): ZodBranded<ZodAny, B>

Type parameters

NameType
Bextends string | number | symbol

Parameters

NameType
brand?B

Returns

ZodBranded<ZodAny, B>

Inherited from

ZodType.brand


catch

catch(def): ZodCatch<ZodAny>

Parameters

NameType
defany

Returns

ZodCatch<ZodAny>

Inherited from

ZodType.catch

catch(def): ZodCatch<ZodAny>

Parameters

NameType
def(ctx: { error: ZodError<any> ; input: any }) => any

Returns

ZodCatch<ZodAny>

Inherited from

ZodType.catch


default

default(def): ZodDefault<ZodAny>

Parameters

NameType
defany

Returns

ZodDefault<ZodAny>

Inherited from

ZodType.default

default(def): ZodDefault<ZodAny>

Parameters

NameType
def() => any

Returns

ZodDefault<ZodAny>

Inherited from

ZodType.default


describe

describe(description): this

Parameters

NameType
descriptionstring

Returns

this

Inherited from

ZodType.describe


isNullable

isNullable(): boolean

Returns

boolean

Inherited from

ZodType.isNullable


isOptional

isOptional(): boolean

Returns

boolean

Inherited from

ZodType.isOptional


nullable

nullable(): ZodNullable<ZodAny>

Returns

ZodNullable<ZodAny>

Inherited from

ZodType.nullable


nullish

nullish(): ZodOptional<ZodNullable<ZodAny>>

Returns

ZodOptional<ZodNullable<ZodAny>>

Inherited from

ZodType.nullish


optional

optional(): ZodOptional<ZodAny>

Returns

ZodOptional<ZodAny>

Inherited from

ZodType.optional


or

or<T>(option): ZodUnion<[ZodAny, T]>

Type parameters

NameType
Textends ZodTypeAny

Parameters

NameType
optionT

Returns

ZodUnion<[ZodAny, T]>

Inherited from

ZodType.or


parse

parse(data, params?): any

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

any

Inherited from

ZodType.parse


parseAsync

parseAsync(data, params?): Promise<any>

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

Promise<any>

Inherited from

ZodType.parseAsync


pipe

pipe<T>(target): ZodPipeline<ZodAny, T>

Type parameters

NameType
Textends ZodTypeAny

Parameters

NameType
targetT

Returns

ZodPipeline<ZodAny, T>

Inherited from

ZodType.pipe


promise

promise(): ZodPromise<ZodAny>

Returns

ZodPromise<ZodAny>

Inherited from

ZodType.promise


readonly

readonly(): ZodReadonly<ZodAny>

Returns

ZodReadonly<ZodAny>

Inherited from

ZodType.readonly


refine

refine<RefinedOutput>(check, message?): ZodEffects<ZodAny, RefinedOutput, any>

Type parameters

NameType
RefinedOutputextends any

Parameters

NameType
check(arg: any) => arg is RefinedOutput
message?string | Partial<Omit<ZodCustomIssue, "code">> | (arg: any) => Partial<Omit<ZodCustomIssue, "code">>

Returns

ZodEffects<ZodAny, RefinedOutput, any>

Inherited from

ZodType.refine

refine(check, message?): ZodEffects<ZodAny, any, any>

Parameters

NameType
check(arg: any) => unknown
message?string | Partial<Omit<ZodCustomIssue, "code">> | (arg: any) => Partial<Omit<ZodCustomIssue, "code">>

Returns

ZodEffects<ZodAny, any, any>

Inherited from

ZodType.refine


refinement

refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodAny, RefinedOutput, any>

Type parameters

NameType
RefinedOutputextends any

Parameters

NameType
check(arg: any) => arg is RefinedOutput
refinementDataIssueData | (arg: any, ctx: RefinementCtx) => IssueData

Returns

ZodEffects<ZodAny, RefinedOutput, any>

Inherited from

ZodType.refinement

refinement(check, refinementData): ZodEffects<ZodAny, any, any>

Parameters

NameType
check(arg: any) => boolean
refinementDataIssueData | (arg: any, ctx: RefinementCtx) => IssueData

Returns

ZodEffects<ZodAny, any, any>

Inherited from

ZodType.refinement


safeParse

safeParse(data, params?): SafeParseReturnType<any, any>

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

SafeParseReturnType<any, any>

Inherited from

ZodType.safeParse


safeParseAsync

safeParseAsync(data, params?): Promise<SafeParseReturnType<any, any>>

Parameters

NameType
dataunknown
params?InexactPartial<ParseParams>

Returns

Promise<SafeParseReturnType<any, any>>

Inherited from

ZodType.safeParseAsync


superRefine

superRefine<RefinedOutput>(refinement): ZodEffects<ZodAny, RefinedOutput, any>

Type parameters

NameType
RefinedOutputextends any

Parameters

NameType
refinement(arg: any, ctx: RefinementCtx) => arg is RefinedOutput

Returns

ZodEffects<ZodAny, RefinedOutput, any>

Inherited from

ZodType.superRefine

superRefine(refinement): ZodEffects<ZodAny, any, any>

Parameters

NameType
refinement(arg: any, ctx: RefinementCtx) => void

Returns

ZodEffects<ZodAny, any, any>

Inherited from

ZodType.superRefine

superRefine(refinement): ZodEffects<ZodAny, any, any>

Parameters

NameType
refinement(arg: any, ctx: RefinementCtx) => Promise<void>

Returns

ZodEffects<ZodAny, any, any>

Inherited from

ZodType.superRefine


transform

transform<NewOut>(transform): ZodEffects<ZodAny, NewOut, any>

Type parameters

Name
NewOut

Parameters

NameType
transform(arg: any, ctx: RefinementCtx) => NewOut | Promise<NewOut>

Returns

ZodEffects<ZodAny, NewOut, any>

Inherited from

ZodType.transform


~validate

~validate(data): Result<any> | Promise<Result<any>>

Parameters

NameType
dataunknown

Returns

Result<any> | Promise<Result<any>>

Inherited from

ZodType.~validate