title: Core.z. Zod Function

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

Class: ZodFunction<Args, Returns>

Core.z.ZodFunction

Type parameters

Name	Type
`Args`	extends `ZodTuple`<`any`, `any`>
`Returns`	extends `ZodTypeAny`

Hierarchy

ZodType<OuterTypeOfFunction<Args, Returns>, ZodFunctionDef<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

↳ ZodFunction

Constructors

constructor

Properties

Accessors

description

Methods

Constructors

constructor

• new ZodFunction<Args, Returns>(def): ZodFunction<Args, Returns>

Type parameters

Name	Type
`Args`	extends `ZodTuple`<`any`, `any`>
`Returns`	extends `ZodTypeAny`

Parameters

Name	Type
`def`	`ZodFunctionDef`<`Args`, `Returns`>

Returns

ZodFunction<Args, Returns>

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodFunctionDef<Args, Returns>

Inherited from

ZodType._def

_input

• Readonly _input: InnerTypeOfFunction<Args, Returns>

Inherited from

ZodType._input

_output

• Readonly _output: OuterTypeOfFunction<Args, Returns>

Inherited from

ZodType._output

_type

• Readonly _type: OuterTypeOfFunction<Args, Returns>

Inherited from

ZodType._type

spa

• spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>

Alias of safeParseAsync

Type declaration

▸ (data, params?): Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>

Inherited from

ZodType.spa

validate

• validate: <F>(func: F) => ReturnType<F> extends Returns["_output"] ? (…args: Args["_input"]) => ReturnType<ReturnType<F>> : OuterTypeOfFunction<Args, Returns>

Type declaration

▸ <F>(func): ReturnType<F> extends Returns["_output"] ? (…args: Args["_input"]) => ReturnType<ReturnType<F>> : OuterTypeOfFunction<Args, Returns>

Type parameters

Name	Type
`F`	extends (…`args`: `any`[`any`]) => `Returns`[`"_input"`]

Parameters

Name	Type
`func`	`F`

Returns

ReturnType<F> extends Returns["_output"] ? (…args: Args["_input"]) => ReturnType<ReturnType<F>> : OuterTypeOfFunction<Args, Returns>

~standard

• ~standard: Props<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>

Inherited from

ZodType.~standard

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

Methods

_getOrReturnCtx

▸ _getOrReturnCtx(input, ctx?): ParseContext

Parameters

Name	Type
`input`	`ParseInput`
`ctx?`	`ParseContext`

Returns

ParseContext

Inherited from

ZodType._getOrReturnCtx

_getType

▸ _getType(input): string

Parameters

Name	Type
`input`	`ParseInput`

Returns

string

Inherited from

ZodType._getType

_parse

▸ _parse(input): ParseReturnType<any>

Parameters

Name	Type
`input`	`ParseInput`

Returns

ParseReturnType<any>

Overrides

ZodType._parse

_parseAsync

▸ _parseAsync(input): AsyncParseReturnType<OuterTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

AsyncParseReturnType<OuterTypeOfFunction<Args, Returns>>

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<OuterTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

SyncParseReturnType<OuterTypeOfFunction<Args, Returns>>

Inherited from

ZodType._parseSync

_processInputParams

▸ _processInputParams(input): Object

Parameters

Name	Type
`input`	`ParseInput`

Returns

Object

Name	Type
`ctx`	`ParseContext`
`status`	`ParseStatus`

Inherited from

ZodType._processInputParams

_refinement

▸ _refinement(refinement): ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`refinement`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>, `ctx`: `RefinementCtx`) => `any`

Returns

ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType._refinement

and

▸ and<T>(incoming): ZodIntersection<ZodFunction<Args, Returns>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodFunction<Args, Returns>, T>

Inherited from

ZodType.and

args

▸ args<Items>(...items): ZodFunction<ZodTuple<Items, ZodUnknown>, Returns>

Type parameters

Name	Type
`Items`	extends [] \| [`ZodTypeAny`, …ZodTypeAny[]]

Parameters

Name	Type
`...items`	`Items`

Returns

ZodFunction<ZodTuple<Items, ZodUnknown>, Returns>

array

▸ array(): ZodArray<ZodFunction<Args, Returns>, "many">

Returns

ZodArray<ZodFunction<Args, Returns>, "many">

Inherited from

ZodType.array

brand

▸ brand<B>(brand?): ZodBranded<ZodFunction<Args, Returns>, B>

Type parameters

Name	Type
`B`	extends `string` \| `number` \| `symbol`

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodFunction<Args, Returns>, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodFunction<Args, Returns>>

Parameters

Name	Type
`def`	`OuterTypeOfFunction`<`Args`, `Returns`>

Returns

ZodCatch<ZodFunction<Args, Returns>>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodFunction<Args, Returns>>

Parameters

Name	Type
`def`	(`ctx`: { `error`: `ZodError`<`any`> ; `input`: `InnerTypeOfFunction`<`Args`, `Returns`> }) => `OuterTypeOfFunction`<`Args`, `Returns`>

▸ create<T>(args): ZodFunction<T, ZodUnknown>

Type parameters

Name	Type
`T`	extends `AnyZodTuple` = `ZodTuple`<[], `ZodUnknown`>

Parameters

Name	Type
`args`	`T`

Returns

ZodFunction<T, ZodUnknown>

▸ create<T, U>(args, returns): ZodFunction<T, U>

Type parameters

Name	Type
`T`	extends `AnyZodTuple`
`U`	extends `ZodTypeAny`

Parameters

Name	Type
`args`	`T`
`returns`	`U`

Returns

ZodFunction<T, U>

▸ create<T, U>(args, returns, params?): ZodFunction<T, U>

Type parameters

Name	Type
`T`	extends `AnyZodTuple` = `ZodTuple`<[], `ZodUnknown`>
`U`	extends `ZodTypeAny` = `ZodUnknown`

Parameters

Name	Type
`args`	`T`
`returns`	`U`
`params?`	`RawCreateParams`

Returns

ZodFunction<T, U>

default

▸ default(def): ZodDefault<ZodFunction<Args, Returns>>

Parameters

Name	Type
`def`	`noUndefined`<`InnerTypeOfFunction`<`Args`, `Returns`>>

Returns

ZodDefault<ZodFunction<Args, Returns>>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodFunction<Args, Returns>>

Parameters

Name	Type
`def`	() => `noUndefined`<`InnerTypeOfFunction`<`Args`, `Returns`>>

Returns

ZodDefault<ZodFunction<Args, Returns>>

Inherited from

ZodType.default

describe

▸ describe(description): this

Parameters

Name	Type
`description`	`string`

Returns

this

Inherited from

ZodType.describe

implement

▸ implement<F>(func): ReturnType<F> extends Returns["_output"] ? (…args: Args["_input"]) => ReturnType<ReturnType<F>> : OuterTypeOfFunction<Args, Returns>

Type parameters

Name	Type
`F`	extends (…`args`: `any`[`any`]) => `Returns`[`"_input"`]

Parameters

Name	Type
`func`	`F`

Returns

ReturnType<F> extends Returns["_output"] ? (…args: Args["_input"]) => ReturnType<ReturnType<F>> : OuterTypeOfFunction<Args, Returns>

isNullable

▸ isNullable(): boolean

Returns

boolean

Inherited from

ZodType.isNullable

isOptional

▸ isOptional(): boolean

Returns

boolean

Inherited from

ZodType.isOptional

nullable

▸ nullable(): ZodNullable<ZodFunction<Args, Returns>>

Returns

ZodNullable<ZodFunction<Args, Returns>>

Inherited from

ZodType.nullable

nullish

▸ nullish(): ZodOptional<ZodNullable<ZodFunction<Args, Returns>>>

Returns

ZodOptional<ZodNullable<ZodFunction<Args, Returns>>>

Inherited from

ZodType.nullish

optional

▸ optional(): ZodOptional<ZodFunction<Args, Returns>>

Returns

ZodOptional<ZodFunction<Args, Returns>>

Inherited from

ZodType.optional

or

▸ or<T>(option): ZodUnion<[ZodFunction<Args, Returns>, T]>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodFunction<Args, Returns>, T]>

Inherited from

ZodType.or

parameters

▸ parameters(): Args

Returns

Args

parse

▸ parse(data, params?): OuterTypeOfFunction<Args, Returns>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

OuterTypeOfFunction<Args, Returns>

Inherited from

ZodType.parse

parseAsync

▸ parseAsync(data, params?): Promise<OuterTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<OuterTypeOfFunction<Args, Returns>>

Inherited from

ZodType.parseAsync

pipe

▸ pipe<T>(target): ZodPipeline<ZodFunction<Args, Returns>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodFunction<Args, Returns>, T>

Inherited from

ZodType.pipe

promise

▸ promise(): ZodPromise<ZodFunction<Args, Returns>>

Returns

ZodPromise<ZodFunction<Args, Returns>>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodFunction<Args, Returns>>

Returns

ZodReadonly<ZodFunction<Args, Returns>>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodFunction<Args, Returns>, RefinedOutput, InnerTypeOfFunction<Args, Returns>>

Type parameters

Name	Type
`RefinedOutput`	extends (…`args`: `any`[`any`]) => `Returns`[`"_output"`]

Parameters

Name	Type
`check`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>) => arg is RefinedOutput
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodFunction<Args, Returns>, RefinedOutput, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`check`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>) => `unknown`
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodFunction<Args, Returns>, RefinedOutput, InnerTypeOfFunction<Args, Returns>>

Type parameters

Name	Type
`RefinedOutput`	extends (…`args`: `any`[`any`]) => `Returns`[`"_output"`]

Parameters

Name	Type
`check`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>) => arg is RefinedOutput
`refinementData`	`IssueData` \| (`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodFunction<Args, Returns>, RefinedOutput, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`check`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>) => `boolean`
`refinementData`	`IssueData` \| (`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.refinement

returnType

▸ returnType(): Returns

Returns

Returns

returns

▸ returns<NewReturnType>(returnType): ZodFunction<Args, NewReturnType>

Type parameters

Name	Type
`NewReturnType`	extends `ZodType`<`any`, `any`, `any`>

Parameters

Name	Type
`returnType`	`NewReturnType`

Returns

ZodFunction<Args, NewReturnType>

safeParse

▸ safeParse(data, params?): SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>

Inherited from

ZodType.safeParse

safeParseAsync

▸ safeParseAsync(data, params?): Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>

Parameters

Name	Type
`data`	`unknown`
`params?`	`InexactPartial`<`ParseParams`>

Returns

Promise<SafeParseReturnType<InnerTypeOfFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>>>

Inherited from

ZodType.safeParseAsync

strictImplement

▸ strictImplement(func): InnerTypeOfFunction<Args, Returns>

Parameters

Name	Type
`func`	`InnerTypeOfFunction`<`Args`, `Returns`>

Returns

InnerTypeOfFunction<Args, Returns>

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodFunction<Args, Returns>, RefinedOutput, InnerTypeOfFunction<Args, Returns>>

Type parameters

Name	Type
`RefinedOutput`	extends (…`args`: `any`[`any`]) => `Returns`[`"_output"`]

Parameters

Name	Type
`refinement`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>, `ctx`: `RefinementCtx`) => arg is RefinedOutput

Returns

ZodEffects<ZodFunction<Args, Returns>, RefinedOutput, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`refinement`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>, `ctx`: `RefinementCtx`) => `void`

Returns

ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Parameters

Name	Type
`refinement`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>, `ctx`: `RefinementCtx`) => `Promise`<`void`>

Returns

ZodEffects<ZodFunction<Args, Returns>, OuterTypeOfFunction<Args, Returns>, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.superRefine

transform

▸ transform<NewOut>(transform): ZodEffects<ZodFunction<Args, Returns>, NewOut, InnerTypeOfFunction<Args, Returns>>

Type parameters

Name
`NewOut`

Parameters

Name	Type
`transform`	(`arg`: `OuterTypeOfFunction`<`Args`, `Returns`>, `ctx`: `RefinementCtx`) => `NewOut` \| `Promise`<`NewOut`>

Returns

ZodEffects<ZodFunction<Args, Returns>, NewOut, InnerTypeOfFunction<Args, Returns>>

Inherited from

ZodType.transform

~validate

▸ ~validate(data): Result<OuterTypeOfFunction<Args, Returns>> | Promise<Result<OuterTypeOfFunction<Args, Returns>>>

Parameters

Name	Type
`data`	`unknown`

Returns

Result<OuterTypeOfFunction<Args, Returns>> | Promise<Result<OuterTypeOfFunction<Args, Returns>>>

Inherited from

ZodType.~validate

z.ZodError z.ZodIntersection

title: Core.z. Zod Function

Class: ZodFunction<Args, Returns>

Type parameters

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Parameters

Returns

Inherited from

Properties

_def

Inherited from

_input

Inherited from

_output

Inherited from

_type

Inherited from

spa

Type declaration

Parameters

Returns

Inherited from

validate

Type declaration

Type parameters

Parameters

Returns

~standard

Inherited from

Accessors

description

Returns

Inherited from

Methods

_getOrReturnCtx

Parameters

Returns

Inherited from

_getType

Parameters

Returns

Inherited from

_parse

Parameters

Returns

Overrides

_parseAsync

Parameters

Returns

Inherited from

_parseSync

Parameters

Returns

Inherited from

_processInputParams

Parameters

Returns

Inherited from

_refinement

Parameters

Returns

Inherited from

and

Type parameters

Parameters

Returns

Inherited from

args

Type parameters

Parameters

Returns

array

Returns