Class ZodArray<T, Cardinality>

Type Parameters

T extends Zod.ZodTypeAny
Cardinality extends Zod.ArrayCardinality = "many"

Hierarchy (View Summary)

Zod.ZodType<
    Zod.arrayOutputType<T, Cardinality>,
    Zod.ZodArrayDef<T>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
- ZodArray

Index

Constructors

constructor

new ZodArray<
    T extends Zod.ZodTypeAny,
    Cardinality extends Zod.ArrayCardinality = "many",
>(
    def: Zod.ZodArrayDef,
): Zod.ZodArray<T, Cardinality>
Type Parameters
- T extends Zod.ZodTypeAny
- Cardinality extends Zod.ArrayCardinality = "many"
Parameters
- def: Zod.ZodArrayDef
Returns Zod.ZodArray<T, Cardinality>
Inherited from ZodType.constructor

Properties

`Readonly`_def

_def: Zod.ZodArrayDef

`Readonly`_input

_input: Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][]

`Readonly`_output

_output: Zod.arrayOutputType

`Readonly`_type

_type: Zod.arrayOutputType

spa

spa: (
    data: unknown,
    params?: Partial<Zod.ParseParams>,
) => Promise<
    Zod.SafeParseReturnType<
        Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][],
        Zod.arrayOutputType<T, Cardinality>,
    >,
>

Alias of safeParseAsync

`Static`create

create: <T_1 extends Zod.ZodTypeAny>(
schema: T_1,
params?: Zod.RawCreateParams,
) => Zod.ZodArray<T_1, "many">

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description

element

get element(): T
Returns T

Methods

_getOrReturnCtx

_getOrReturnCtx(input: Zod.ParseInput, ctx?: Zod.ParseContext): Zod.ParseContext
Parameters
- input: Zod.ParseInput
- Optionalctx: Zod.ParseContext
Returns Zod.ParseContext
Inherited from ZodType._getOrReturnCtx

_getType

_getType(input: Zod.ParseInput): string
Parameters
- input: Zod.ParseInput
Returns string
Inherited from ZodType._getType

_parse

_parse(
input: Zod.ParseInput,
): Zod.ParseReturnType<Zod.arrayOutputType<T, Cardinality>>
Parameters
- input: Zod.ParseInput
Returns Zod.ParseReturnType<Zod.arrayOutputType<T, Cardinality>>
Overrides ZodType._parse

_parseAsync

_parseAsync(
input: Zod.ParseInput,
): Zod.AsyncParseReturnType<Zod.arrayOutputType<T, Cardinality>>
Parameters
- input: Zod.ParseInput
Returns Zod.AsyncParseReturnType<Zod.arrayOutputType<T, Cardinality>>
Inherited from ZodType._parseAsync

_parseSync

_parseSync(
input: Zod.ParseInput,
): Zod.SyncParseReturnType<Zod.arrayOutputType<T, Cardinality>>
Parameters
- input: Zod.ParseInput
Returns Zod.SyncParseReturnType<Zod.arrayOutputType<T, Cardinality>>
Inherited from ZodType._parseSync

_processInputParams

_processInputParams(
input: Zod.ParseInput,
): { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Parameters
- input: Zod.ParseInput
Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }
Inherited from ZodType._processInputParams

_refinement

_refinement(
    refinement: (arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => any,
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Parameters
- refinement: (arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => any
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType._refinement

and

and<T extends Zod.ZodTypeAny>(
incoming: T,
): Zod.ZodIntersection<Zod.ZodArray<T, Cardinality>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- incoming: T
Returns Zod.ZodIntersection<Zod.ZodArray<T, Cardinality>, T>
Inherited from ZodType.and

array

array(): Zod.ZodArray<Zod.ZodArray<T, Cardinality>>
Returns Zod.ZodArray<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.array

brand

brand<B extends string | number | symbol>(
brand?: B,
): Zod.ZodBranded<Zod.ZodArray<T, Cardinality>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optionalbrand: B
Returns Zod.ZodBranded<Zod.ZodArray<T, Cardinality>, B>
Inherited from ZodType.brand

catch

catch(def: Zod.arrayOutputType): Zod.ZodCatch<Zod.ZodArray<T, Cardinality>>
Parameters
- def: Zod.arrayOutputType
Returns Zod.ZodCatch<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.catch
catch(
    def: (
        ctx: {
            error: Zod.ZodError;
            input: Cardinality extends "atleastone"
                ? [T["_input"], ...T["_input"][]]
                : T["_input"][];
        },
    ) => Zod.arrayOutputType,
): Zod.ZodCatch<Zod.ZodArray<T, Cardinality>>
Parameters
- def: (
      ctx: {
          error: Zod.ZodError;
          input: Cardinality extends "atleastone"
              ? [T["_input"], ...T["_input"][]]
              : T["_input"][];
      },
  ) => Zod.arrayOutputType
Returns Zod.ZodCatch<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.catch

default

default(
    def: noUndefined<
        Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][],
    >,
): Zod.ZodDefault<Zod.ZodArray<T, Cardinality>>
Parameters
- def: noUndefined<
      Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][],
  >
Returns Zod.ZodDefault<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.default
default(
    def: () => noUndefined<
        Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][],
    >,
): Zod.ZodDefault<Zod.ZodArray<T, Cardinality>>
Parameters
- def: () => noUndefined<
      Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][],
  >
Returns Zod.ZodDefault<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.default

describe

describe(description: string): this
Parameters
- 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: number, message?: ErrMessage): this
Parameters
- len: number
- Optionalmessage: ErrMessage
Returns this

max

max(maxLength: number, message?: ErrMessage): this
Parameters
- maxLength: number
- Optionalmessage: ErrMessage
Returns this

min

min(minLength: number, message?: ErrMessage): this
Parameters
- minLength: number
- Optionalmessage: ErrMessage
Returns this

nonempty

nonempty(message?: ErrMessage): Zod.ZodArray<T, "atleastone">
Parameters
- Optionalmessage: ErrMessage
Returns Zod.ZodArray<T, "atleastone">

nullable

nullable(): Zod.ZodNullable<Zod.ZodArray<T, Cardinality>>
Returns Zod.ZodNullable<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.nullable

nullish

nullish(): Zod.ZodOptional<Zod.ZodNullable<Zod.ZodArray<T, Cardinality>>>
Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodArray<T, Cardinality>>>
Inherited from ZodType.nullish

optional

optional(): Zod.ZodOptional<Zod.ZodArray<T, Cardinality>>
Returns Zod.ZodOptional<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.optional

or

or<T extends Zod.ZodTypeAny>(
option: T,
): Zod.ZodUnion<[Zod.ZodArray<T, Cardinality>, T]>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- option: T
Returns Zod.ZodUnion<[Zod.ZodArray<T, Cardinality>, T]>
Inherited from ZodType.or

parse

parse(data: unknown, params?: Partial<Zod.ParseParams>): Zod.arrayOutputType
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.arrayOutputType
Inherited from ZodType.parse

parseAsync

parseAsync(
data: unknown,
params?: Partial<Zod.ParseParams>,
): Promise<Zod.arrayOutputType<T, Cardinality>>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<Zod.arrayOutputType<T, Cardinality>>
Inherited from ZodType.parseAsync

pipe

pipe<T extends Zod.ZodTypeAny>(
target: T,
): Zod.ZodPipeline<Zod.ZodArray<T, Cardinality>, T>
Type Parameters
- T extends Zod.ZodTypeAny
Parameters
- target: T
Returns Zod.ZodPipeline<Zod.ZodArray<T, Cardinality>, T>
Inherited from ZodType.pipe

promise

promise(): Zod.ZodPromise<Zod.ZodArray<T, Cardinality>>
Returns Zod.ZodPromise<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.promise

readonly

readonly(): Zod.ZodReadonly<Zod.ZodArray<T, Cardinality>>
Returns Zod.ZodReadonly<Zod.ZodArray<T, Cardinality>>
Inherited from ZodType.readonly

refine

refine<RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]>(
    check: (arg: Zod.arrayOutputType) => arg is RefinedOutput,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: Zod.arrayOutputType) => Zod.CustomErrorParams),
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    RefinedOutput,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Type Parameters
- RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]
Parameters
- check: (arg: Zod.arrayOutputType) => arg is RefinedOutput
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: Zod.arrayOutputType) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    RefinedOutput,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType.refine
refine(
    check: (arg: Zod.arrayOutputType) => unknown,
    message?:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: Zod.arrayOutputType) => Zod.CustomErrorParams),
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Parameters
- check: (arg: Zod.arrayOutputType) => unknown
- Optionalmessage:
      | string
      | Partial<Omit<Zod.ZodCustomIssue, "code">>
      | ((arg: Zod.arrayOutputType) => Zod.CustomErrorParams)
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType.refine

refinement<
    RefinedOutput extends [T["_output"], ...T["_output"][]]
    | T["_output"][],
>(
    check: (arg: Zod.arrayOutputType) => arg is RefinedOutput,
    refinementData:
        | Zod.IssueData
        | ((arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    RefinedOutput,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Type Parameters
- RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]
Parameters
- check: (arg: Zod.arrayOutputType) => arg is RefinedOutput
- refinementData:
  | Zod.IssueData
  | ((arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    RefinedOutput,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType.refinement
refinement(
    check: (arg: Zod.arrayOutputType) => boolean,
    refinementData:
        | Zod.IssueData
        | ((arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => Zod.IssueData),
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Parameters
- check: (arg: Zod.arrayOutputType) => boolean
- refinementData:
  | Zod.IssueData
  | ((arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => Zod.IssueData)
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType.refinement

safeParse

safeParse(
    data: unknown,
    params?: Partial<Zod.ParseParams>,
): Zod.SafeParseReturnType<
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
    Zod.arrayOutputType<T, Cardinality>,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Zod.SafeParseReturnType<
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
    Zod.arrayOutputType<T, Cardinality>,
>
Inherited from ZodType.safeParse

safeParseAsync

safeParseAsync(
    data: unknown,
    params?: Partial<Zod.ParseParams>,
): Promise<
    Zod.SafeParseReturnType<
        Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][],
        Zod.arrayOutputType<T, Cardinality>,
    >,
>
Parameters
- data: unknown
- Optionalparams: Partial<Zod.ParseParams>
Returns Promise<
    Zod.SafeParseReturnType<
        Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][],
        Zod.arrayOutputType<T, Cardinality>,
    >,
>
Inherited from ZodType.safeParseAsync

superRefine

superRefine<
    RefinedOutput extends [T["_output"], ...T["_output"][]]
    | T["_output"][],
>(
    refinement: (
        arg: Zod.arrayOutputType,
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput,
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    RefinedOutput,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Type Parameters
- RefinedOutput extends [T["_output"], ...T["_output"][]] | T["_output"][]
Parameters
- refinement: (arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => arg is RefinedOutput
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    RefinedOutput,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType.superRefine
superRefine(
    refinement: (arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => void,
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Parameters
- refinement: (arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => void
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType.superRefine
superRefine(
    refinement: (
        arg: Zod.arrayOutputType,
        ctx: Zod.RefinementCtx,
    ) => Promise<void>,
): Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Parameters
- refinement: (arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => Promise<void>
Returns Zod.ZodEffects<
    Zod.ZodArray<T, Cardinality>,
    Zod.arrayOutputType<T, Cardinality>,
    Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][],
>
Inherited from ZodType.superRefine

transform

transform<NewOut>(
    transform: (
        arg: Zod.arrayOutputType,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>,
): Zod.ZodEffects<Zod.ZodArray<T, Cardinality>, NewOut>
Type Parameters
- NewOut
Parameters
- transform: (arg: Zod.arrayOutputType, ctx: Zod.RefinementCtx) => NewOut | Promise<NewOut>
Returns Zod.ZodEffects<Zod.ZodArray<T, Cardinality>, NewOut>
Inherited from ZodType.transform

Class ZodArray<T, Cardinality>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Zod.ZodArray<T, Cardinality>

Properties

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

Staticcreate

Accessors

description

Returns undefined | string

element

Returns T

Methods

_getOrReturnCtx

Parameters

Returns Zod.ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns Zod.ParseReturnType<Zod.arrayOutputType<T, Cardinality>>

_parseAsync

Parameters

Returns Zod.AsyncParseReturnType<Zod.arrayOutputType<T, Cardinality>>

_parseSync

Parameters

Returns Zod.SyncParseReturnType<Zod.arrayOutputType<T, Cardinality>>

_processInputParams

Parameters

Returns { ctx: Zod.ParseContext; status: Zod.ParseStatus }

_refinement

Parameters

Returns Zod.ZodEffects< Zod.ZodArray<T, Cardinality>, Zod.arrayOutputType<T, Cardinality>, Cardinality extends "atleastone" ? [T["_input"], ...T["_input"][]] : T["_input"][],>

and

Type Parameters

Parameters

Returns Zod.ZodIntersection<Zod.ZodArray<T, Cardinality>, T>

array

Returns Zod.ZodArray<Zod.ZodArray<T, Cardinality>>

brand

Type Parameters

Parameters

Returns Zod.ZodBranded<Zod.ZodArray<T, Cardinality>, B>

catch

Parameters

Returns Zod.ZodCatch<Zod.ZodArray<T, Cardinality>>

Parameters

Returns Zod.ZodCatch<Zod.ZodArray<T, Cardinality>>

default

Parameters

Returns Zod.ZodDefault<Zod.ZodArray<T, Cardinality>>

Parameters

Returns Zod.ZodDefault<Zod.ZodArray<T, Cardinality>>

describe

Parameters

Returns this

isNullable

Returns boolean

isOptional

Returns boolean

length

Parameters

Returns this

max

Parameters

Returns this

`Readonly`_def

`Readonly`_input

`Readonly`_output

`Readonly`_type

`Static`create

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
Zod.arrayOutputType<T, Cardinality>,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
RefinedOutput,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
Zod.arrayOutputType<T, Cardinality>,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
RefinedOutput,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
Zod.arrayOutputType<T, Cardinality>,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>

Returns Zod.SafeParseReturnType<
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
Zod.arrayOutputType<T, Cardinality>,
>

Returns Promise<
Zod.SafeParseReturnType<
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
Zod.arrayOutputType<T, Cardinality>,
>,
>

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
RefinedOutput,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
Zod.arrayOutputType<T, Cardinality>,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>

Returns Zod.ZodEffects<
Zod.ZodArray<T, Cardinality>,
Zod.arrayOutputType<T, Cardinality>,
Cardinality extends "atleastone"
? [T["_input"], ...T["_input"][]]
: T["_input"][],
>