title: Core.z. Zod Tuple

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

Class: ZodTuple<T, Rest>

Core.z.ZodTuple

Type parameters

Name	Type
`T`	extends `ZodTupleItems` \| [] = `ZodTupleItems`
`Rest`	extends `ZodTypeAny` \| `null` = `null`

Hierarchy

ZodType<OutputTypeOfTupleWithRest<T, Rest>, ZodTupleDef<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

↳ ZodTuple

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new ZodTuple<T, Rest>(def): ZodTuple<T, Rest>

Type parameters

Name	Type
`T`	extends [] \| `ZodTupleItems` = `ZodTupleItems`
`Rest`	extends `null` \| `ZodTypeAny` = `null`

Parameters

Name	Type
`def`	`ZodTupleDef`<`T`, `Rest`>

Returns

ZodTuple<T, Rest>

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodTupleDef<T, Rest>

Inherited from

ZodType._def

_input

• Readonly _input: InputTypeOfTupleWithRest<T, Rest>

Inherited from

ZodType._input

_output

• Readonly _output: OutputTypeOfTupleWithRest<T, Rest>

Inherited from

ZodType._output

_type

• Readonly _type: OutputTypeOfTupleWithRest<T, Rest>

Inherited from

ZodType._type

create

▪ Static create: <Items>(schemas: Items, params?: RawCreateParams) => ZodTuple<Items, null>

Type declaration

▸ <Items>(schemas, params?): ZodTuple<Items, null>

Type parameters

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

Parameters

Name	Type
`schemas`	`Items`
`params?`	`RawCreateParams`

Returns

ZodTuple<Items, null>

spa

• spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>>

Alias of safeParseAsync

Type declaration

▸ (data, params?): Promise<SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>>

Parameters

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

Returns

Promise<SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>>

Inherited from

ZodType.spa

~standard

• ~standard: Props<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.~standard

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

items

• get items(): T

Returns

T

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<OutputTypeOfTupleWithRest<T, Rest>>

Parameters

Name	Type
`input`	`ParseInput`

Parameters

Name	Type
`input`	`ParseInput`

Returns

AsyncParseReturnType<OutputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<OutputTypeOfTupleWithRest<T, Rest>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

SyncParseReturnType<OutputTypeOfTupleWithRest<T, Rest>>

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<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Parameters

Name	Type
`refinement`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>, `ctx`: `RefinementCtx`) => `any`

Returns

ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType._refinement

and

▸ and<T>(incoming): ZodIntersection<ZodTuple<T, Rest>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodTuple<T, Rest>, T>

Inherited from

ZodType.and

array

▸ array(): ZodArray<ZodTuple<T, Rest>, "many">

Returns

ZodArray<ZodTuple<T, Rest>, "many">

Inherited from

ZodType.array

brand

▸ brand<B>(brand?): ZodBranded<ZodTuple<T, Rest>, B>

Type parameters

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

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodTuple<T, Rest>, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodTuple<T, Rest>>

Parameters

Name	Type
`def`	`OutputTypeOfTupleWithRest`<`T`, `Rest`>

Returns

ZodCatch<ZodTuple<T, Rest>>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodTuple<T, Rest>>

Parameters

Name	Type
`def`	(`ctx`: { `error`: `ZodError`<`any`> ; `input`: `InputTypeOfTupleWithRest`<`T`, `Rest`> }) => `OutputTypeOfTupleWithRest`<`T`, `Rest`>

Returns

ZodCatch<ZodTuple<T, Rest>>

Inherited from

ZodType.catch

default

▸ default(def): ZodDefault<ZodTuple<T, Rest>>

Parameters

Name	Type
`def`	`noUndefined`<`InputTypeOfTupleWithRest`<`T`, `Rest`>>

Returns

ZodDefault<ZodTuple<T, Rest>>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodTuple<T, Rest>>

Parameters

Name	Type
`def`	() => `noUndefined`<`InputTypeOfTupleWithRest`<`T`, `Rest`>>

Returns

ZodDefault<ZodTuple<T, Rest>>

Inherited from

ZodType.default

describe

▸ describe(description): this

Parameters

Name	Type
`description`	`string`

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<ZodTuple<T, Rest>>

Returns

ZodNullable<ZodTuple<T, Rest>>

Inherited from

ZodType.nullable

nullish

▸ nullish(): ZodOptional<ZodNullable<ZodTuple<T, Rest>>>

Returns

ZodOptional<ZodNullable<ZodTuple<T, Rest>>>

Inherited from

ZodType.nullish

optional

▸ optional(): ZodOptional<ZodTuple<T, Rest>>

Returns

ZodOptional<ZodTuple<T, Rest>>

Inherited from

ZodType.optional

or

▸ or<T>(option): ZodUnion<[ZodTuple<T, Rest>, T]>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodTuple<T, Rest>, T]>

Inherited from

ZodType.or

parse

▸ parse(data, params?): OutputTypeOfTupleWithRest<T, Rest>

Parameters

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

Returns

OutputTypeOfTupleWithRest<T, Rest>

Inherited from

ZodType.parse

parseAsync

▸ parseAsync(data, params?): Promise<OutputTypeOfTupleWithRest<T, Rest>>

Parameters

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

Returns

Promise<OutputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.parseAsync

pipe

▸ pipe<T>(target): ZodPipeline<ZodTuple<T, Rest>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodTuple<T, Rest>, T>

Inherited from

ZodType.pipe

promise

▸ promise(): ZodPromise<ZodTuple<T, Rest>>

Returns

ZodPromise<ZodTuple<T, Rest>>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodTuple<T, Rest>>

Returns

ZodReadonly<ZodTuple<T, Rest>>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodTuple<T, Rest>, RefinedOutput, InputTypeOfTupleWithRest<T, Rest>>

Type parameters

Name	Type
`RefinedOutput`	extends […AssertArray<{ [k in string \| number \| symbol]: T[k<k>] extends ZodType<any, any, any> ? any[any][“_output”] : never }>[], …any[]] \| `any`[] & { [k in string \| number \| symbol]: T[k<k>] extends ZodType<any, any, any> ? any[any][“_output”] : never }

Parameters

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

Returns

ZodEffects<ZodTuple<T, Rest>, RefinedOutput, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Parameters

Name	Type
`check`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>) => `unknown`
`message?`	`string` \| `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>> \| (`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>) => `Partial`<`Omit`<`ZodCustomIssue`, `"code"`>>

Returns

ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodTuple<T, Rest>, RefinedOutput, InputTypeOfTupleWithRest<T, Rest>>

Type parameters

Name	Type
`RefinedOutput`	extends […AssertArray<{ [k in string \| number \| symbol]: T[k<k>] extends ZodType<any, any, any> ? any[any][“_output”] : never }>[], …any[]] \| `any`[] & { [k in string \| number \| symbol]: T[k<k>] extends ZodType<any, any, any> ? any[any][“_output”] : never }

Parameters

Name	Type
`check`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>) => arg is RefinedOutput
`refinementData`	`IssueData` \| (`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodTuple<T, Rest>, RefinedOutput, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Parameters

Name	Type
`check`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>) => `boolean`
`refinementData`	`IssueData` \| (`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>, `ctx`: `RefinementCtx`) => `IssueData`

Returns

ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.refinement

rest

▸ rest<RestSchema>(rest): ZodTuple<T, RestSchema>

Type parameters

Name	Type
`RestSchema`	extends `ZodTypeAny`

Parameters

Name	Type
`rest`	`RestSchema`

Returns

ZodTuple<T, RestSchema>

safeParse

▸ safeParse(data, params?): SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>

Parameters

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

Returns

SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.safeParse

safeParseAsync

▸ safeParseAsync(data, params?): Promise<SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>>

Parameters

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

Returns

Promise<SafeParseReturnType<InputTypeOfTupleWithRest<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>>>

Inherited from

ZodType.safeParseAsync

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodTuple<T, Rest>, RefinedOutput, InputTypeOfTupleWithRest<T, Rest>>

Type parameters

Name	Type
`RefinedOutput`	extends […AssertArray<{ [k in string \| number \| symbol]: T[k<k>] extends ZodType<any, any, any> ? any[any][“_output”] : never }>[], …any[]] \| `any`[] & { [k in string \| number \| symbol]: T[k<k>] extends ZodType<any, any, any> ? any[any][“_output”] : never }

Parameters

Name	Type
`refinement`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>, `ctx`: `RefinementCtx`) => arg is RefinedOutput

Returns

ZodEffects<ZodTuple<T, Rest>, RefinedOutput, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Parameters

Name	Type
`refinement`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>, `ctx`: `RefinementCtx`) => `void`

Returns

ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Parameters

Name	Type
`refinement`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>, `ctx`: `RefinementCtx`) => `Promise`<`void`>

Returns

ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.superRefine

transform

▸ transform<NewOut>(transform): ZodEffects<ZodTuple<T, Rest>, NewOut, InputTypeOfTupleWithRest<T, Rest>>

Type parameters

Name
`NewOut`

Parameters

Name	Type
`transform`	(`arg`: `OutputTypeOfTupleWithRest`<`T`, `Rest`>, `ctx`: `RefinementCtx`) => `NewOut` \| `Promise`<`NewOut`>

Returns

ZodEffects<ZodTuple<T, Rest>, NewOut, InputTypeOfTupleWithRest<T, Rest>>

Inherited from

ZodType.transform

~validate

▸ ~validate(data): Result<OutputTypeOfTupleWithRest<T, Rest>> | Promise<Result<OutputTypeOfTupleWithRest<T, Rest>>>

Parameters

Name	Type
`data`	`unknown`

Returns

Result<OutputTypeOfTupleWithRest<T, Rest>> | Promise<Result<OutputTypeOfTupleWithRest<T, Rest>>>

Inherited from

ZodType.~validate

z.ZodSymbol z.ZodType

title: Core.z. Zod Tuple

Class: ZodTuple<T, Rest>

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

create

Type declaration

Type parameters

Parameters

Returns

spa

Type declaration

Parameters

Returns

Inherited from

~standard

Inherited from

Accessors

description

Returns

Inherited from

items

Returns

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

array

Returns

Inherited from

brand