title: Core.z. Zod Array

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

Class: ZodArray<T, Cardinality>

Core.z.ZodArray

Type parameters

Name	Type
`T`	extends `ZodTypeAny`
`Cardinality`	extends `ArrayCardinality` = `"many"`

Hierarchy

ZodType<arrayOutputType<T, Cardinality>, ZodArrayDef<T>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

↳ ZodArray

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new ZodArray<T, Cardinality>(def): ZodArray<T, Cardinality>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`
`Cardinality`	extends `ArrayCardinality` = `"many"`

Parameters

Name	Type
`def`	`ZodArrayDef`<`T`>

Returns

ZodArray<T, Cardinality>

Inherited from

ZodType.constructor

Properties

_def

• Readonly _def: ZodArrayDef<T>

Inherited from

ZodType._def

_input

• Readonly _input: Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]

Inherited from

ZodType._input

_output

• Readonly _output: arrayOutputType<T, Cardinality>

Inherited from

ZodType._output

_type

• Readonly _type: arrayOutputType<T, Cardinality>

Inherited from

ZodType._type

create

▪ Static create: <El>(schema: El, params?: RawCreateParams) => ZodArray<El, "many">

Type declaration

▸ <El>(schema, params?): ZodArray<El, "many">

Type parameters

Name	Type
`El`	extends `ZodTypeAny`

Parameters

Name	Type
`schema`	`El`
`params?`	`RawCreateParams`

Returns

ZodArray<El, "many">

spa

• spa: (data: unknown, params?: InexactPartial<ParseParams>) => Promise<SafeParseReturnType<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>>

Alias of safeParseAsync

Type declaration

▸ (data, params?): Promise<SafeParseReturnType<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>>

Parameters

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

Returns

Promise<SafeParseReturnType<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>>

Inherited from

ZodType.spa

~standard

• ~standard: Props<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>

Inherited from

ZodType.~standard

Accessors

description

• get description(): undefined | string

Returns

undefined | string

Inherited from

ZodType.description

element

• get element(): 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<arrayOutputType<T, Cardinality>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

ParseReturnType<arrayOutputType<T, Cardinality>>

Overrides

ZodType._parse

_parseAsync

▸ _parseAsync(input): AsyncParseReturnType<arrayOutputType<T, Cardinality>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

AsyncParseReturnType<arrayOutputType<T, Cardinality>>

Inherited from

ZodType._parseAsync

_parseSync

▸ _parseSync(input): SyncParseReturnType<arrayOutputType<T, Cardinality>>

Parameters

Name	Type
`input`	`ParseInput`

Returns

SyncParseReturnType<arrayOutputType<T, Cardinality>>

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<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType._refinement

and

▸ and<T>(incoming): ZodIntersection<ZodArray<T, Cardinality>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`incoming`	`T`

Returns

ZodIntersection<ZodArray<T, Cardinality>, T>

Inherited from

ZodType.and

array

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

Returns

ZodArray<ZodArray<T, Cardinality>, "many">

Inherited from

ZodType.array

brand

▸ brand<B>(brand?): ZodBranded<ZodArray<T, Cardinality>, B>

Type parameters

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

Parameters

Name	Type
`brand?`	`B`

Returns

ZodBranded<ZodArray<T, Cardinality>, B>

Inherited from

ZodType.brand

catch

▸ catch(def): ZodCatch<ZodArray<T, Cardinality>>

Parameters

Name	Type
`def`	`arrayOutputType`<`T`, `Cardinality`>

Returns

ZodCatch<ZodArray<T, Cardinality>>

Inherited from

ZodType.catch

▸ catch(def): ZodCatch<ZodArray<T, Cardinality>>

Parameters

Name	Type
`def`	(`ctx`: { `error`: `ZodError`<`any`> ; `input`: `Cardinality` extends `"atleastone"` ? [`T`[`"_input"`], …T[“_input”][]] : `T`[`"_input"`][] }) => `arrayOutputType`<`T`, `Cardinality`>

Returns

ZodCatch<ZodArray<T, Cardinality>>

Inherited from

ZodType.catch

default

▸ default(def): ZodDefault<ZodArray<T, Cardinality>>

Parameters

Name	Type
`def`	`noUndefined`<`Cardinality` extends `"atleastone"` ? [`T`[`"_input"`], …T[“_input”][]] : `T`[`"_input"`][]>

Returns

ZodDefault<ZodArray<T, Cardinality>>

Inherited from

ZodType.default

▸ default(def): ZodDefault<ZodArray<T, Cardinality>>

Parameters

Name	Type
`def`	() => `noUndefined`<`Cardinality` extends `"atleastone"` ? [`T`[`"_input"`], …T[“_input”][]] : `T`[`"_input"`][]>

Returns

ZodDefault<ZodArray<T, Cardinality>>

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

length

▸ length(len, message?): this

Parameters

Name	Type
`len`	`number`
`message?`	`ErrMessage`

Returns

this

max

▸ max(maxLength, message?): this

Parameters

Name	Type
`maxLength`	`number`
`message?`	`ErrMessage`

Returns

this

min

▸ min(minLength, message?): this

Parameters

Name	Type
`minLength`	`number`
`message?`	`ErrMessage`

Returns

this

nonempty

▸ nonempty(message?): ZodArray<T, "atleastone">

Parameters

Name	Type
`message?`	`ErrMessage`

Returns

ZodArray<T, "atleastone">

nullable

▸ nullable(): ZodNullable<ZodArray<T, Cardinality>>

Returns

ZodNullable<ZodArray<T, Cardinality>>

Inherited from

ZodType.nullable

nullish

▸ nullish(): ZodOptional<ZodNullable<ZodArray<T, Cardinality>>>

Returns

ZodOptional<ZodNullable<ZodArray<T, Cardinality>>>

Inherited from

ZodType.nullish

optional

▸ optional(): ZodOptional<ZodArray<T, Cardinality>>

Returns

ZodOptional<ZodArray<T, Cardinality>>

Inherited from

ZodType.optional

or

▸ or<T>(option): ZodUnion<[ZodArray<T, Cardinality>, T]>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`option`	`T`

Returns

ZodUnion<[ZodArray<T, Cardinality>, T]>

Inherited from

ZodType.or

parse

▸ parse(data, params?): arrayOutputType<T, Cardinality>

Parameters

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

Returns

arrayOutputType<T, Cardinality>

Inherited from

ZodType.parse

parseAsync

▸ parseAsync(data, params?): Promise<arrayOutputType<T, Cardinality>>

Parameters

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

Returns

Promise<arrayOutputType<T, Cardinality>>

Inherited from

ZodType.parseAsync

pipe

▸ pipe<T>(target): ZodPipeline<ZodArray<T, Cardinality>, T>

Type parameters

Name	Type
`T`	extends `ZodTypeAny`

Parameters

Name	Type
`target`	`T`

Returns

ZodPipeline<ZodArray<T, Cardinality>, T>

Inherited from

ZodType.pipe

promise

▸ promise(): ZodPromise<ZodArray<T, Cardinality>>

Returns

ZodPromise<ZodArray<T, Cardinality>>

Inherited from

ZodType.promise

readonly

▸ readonly(): ZodReadonly<ZodArray<T, Cardinality>>

Returns

ZodReadonly<ZodArray<T, Cardinality>>

Inherited from

ZodType.readonly

refine

▸ refine<RefinedOutput>(check, message?): ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Type parameters

Name	Type
`RefinedOutput`	extends [`T`[`"_output"`], …T[“_output”][]] \| `T`[`"_output"`][]

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.refine

▸ refine(check, message?): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.refine

refinement

▸ refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Type parameters

Name	Type
`RefinedOutput`	extends [`T`[`"_output"`], …T[“_output”][]] \| `T`[`"_output"`][]

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.refinement

▸ refinement(check, refinementData): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.refinement

safeParse

▸ safeParse(data, params?): SafeParseReturnType<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>

Parameters

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

Returns

SafeParseReturnType<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>

Inherited from

ZodType.safeParse

safeParseAsync

▸ safeParseAsync(data, params?): Promise<SafeParseReturnType<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>>

Parameters

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

Returns

Promise<SafeParseReturnType<Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][], arrayOutputType<T, Cardinality>>>

Inherited from

ZodType.safeParseAsync

superRefine

▸ superRefine<RefinedOutput>(refinement): ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Type parameters

Name	Type
`RefinedOutput`	extends [`T`[`"_output"`], …T[“_output”][]] \| `T`[`"_output"`][]

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, RefinedOutput, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.superRefine

▸ superRefine(refinement): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.superRefine

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.superRefine

transform

▸ transform<NewOut>(transform): ZodEffects<ZodArray<T, Cardinality>, NewOut, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Type parameters

Name
`NewOut`

Parameters

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

Returns

ZodEffects<ZodArray<T, Cardinality>, NewOut, Cardinality extends "atleastone" ? [T["_input"], …T[“_input”][]] : T["_input"][]>

Inherited from

ZodType.transform

~validate

▸ ~validate(data): Result<arrayOutputType<T, Cardinality>> | Promise<Result<arrayOutputType<T, Cardinality>>>

Parameters

Name	Type
`data`	`unknown`

Returns

Result<arrayOutputType<T, Cardinality>> | Promise<Result<arrayOutputType<T, Cardinality>>>

Inherited from

ZodType.~validate

z.ZodAny z.ZodBigInt

title: Core.z. Zod Array

Class: ZodArray<T, Cardinality>

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

element

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