Class ZodArray<T, Cardinality>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

description

• get description(): undefined | string

• Returns undefined | string

_getOrReturnCtx

• _getOrReturnCtx(input, ctx?): ParseContext

• Parameters

  • input: ParseInput
  • Optionalctx: ParseContext

  Returns ParseContext

_getType

• _getType(input): string

• Parameters

  • input: ParseInput

  Returns string

_parseAsync

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

• Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<arrayOutputType<T, Cardinality>>

_parseSync

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

• Parameters

  • input: ParseInput

  Returns SyncParseReturnType<arrayOutputType<T, Cardinality>>

_processInputParams

• _processInputParams(input): {
      ctx: ParseContext;
      status: ParseStatus;
  }

• Parameters

  • input: ParseInput

  Returns {
      ctx: ParseContext;
      status: ParseStatus;
  }

  • ctx: ParseContext

  • status: ParseStatus

_refinement

• _refinement(refinement): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][]>

• Parameters

  • refinement: ((arg: arrayOutputType<T, Cardinality>, ctx: RefinementCtx) => any)
    • • (arg, ctx): any

      • Parameters

        • arg: arrayOutputType<T, Cardinality>
        • ctx: RefinementCtx

        Returns any

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

and

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

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

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

array

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

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

brand

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

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

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

catch

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

• Parameters

  • def: arrayOutputType<T, Cardinality>

  Returns ZodCatch<ZodArray<T, Cardinality>>

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

• Parameters

  • def: ((ctx: {
        error: ZodError<any>;
        input: Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][];
    }) => arrayOutputType<T, Cardinality>)
    • • (ctx): arrayOutputType<T, Cardinality>

      • Parameters

        • ctx: {
              error: ZodError<any>;
              input: Cardinality extends "atleastone"
                  ? [T["_input"], ...T["_input"][]]
                  : T["_input"][];
          }

          • error: ZodError<any>

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

        Returns arrayOutputType<T, Cardinality>

  Returns ZodCatch<ZodArray<T, Cardinality>>

default

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

• Parameters

  • def: noUndefined<Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>

  Returns ZodDefault<ZodArray<T, Cardinality>>

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

• Parameters

  • def: (() => noUndefined<Cardinality extends "atleastone"
        ? [T["_input"], ...T["_input"][]]
        : T["_input"][]>)
    • • (): noUndefined<Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][]>

      • Returns noUndefined<Cardinality extends "atleastone"
            ? [T["_input"], ...T["_input"][]]
            : T["_input"][]>

  Returns ZodDefault<ZodArray<T, Cardinality>>

describe

• describe(description): this

• Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

• Returns boolean

isOptional

• isOptional(): boolean

• Returns boolean

nullable

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

• Returns ZodNullable<ZodArray<T, Cardinality>>

nullish

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

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

optional

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

• Returns ZodOptional<ZodArray<T, Cardinality>>

or

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

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

parse

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

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns arrayOutputType<T, Cardinality>

parseAsync

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

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<arrayOutputType<T, Cardinality>>

pipe

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

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodArray<T, Cardinality>, T>

promise

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

• Returns ZodPromise<ZodArray<T, Cardinality>>

readonly

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

• Returns ZodReadonly<ZodArray<T, Cardinality>>

refine

• refine<RefinedOutput>(check, message?): ZodEffects<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: arrayOutputType<T, Cardinality>) => arg is RefinedOutput)
    • • (arg): arg is RefinedOutput

      • Parameters

        • arg: arrayOutputType<T, Cardinality>

        Returns arg is RefinedOutput

  • Optionalmessage: 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"][]>

• refine(check, message?): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][]>

• Parameters

  • check: ((arg: arrayOutputType<T, Cardinality>) => unknown)
    • • (arg): unknown

      • Parameters

        • arg: arrayOutputType<T, Cardinality>

        Returns unknown

  • Optionalmessage: 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"][]>

refinement

• refinement<RefinedOutput>(check, refinementData): ZodEffects<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: arrayOutputType<T, Cardinality>) => arg is RefinedOutput)
    • • (arg): arg is RefinedOutput

      • Parameters

        • arg: arrayOutputType<T, Cardinality>

        Returns 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"][]>

• refinement(check, refinementData): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][]>

• Parameters

  • check: ((arg: arrayOutputType<T, Cardinality>) => boolean)
    • • (arg): boolean

      • Parameters

        • arg: arrayOutputType<T, Cardinality>

        Returns 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"][]>

safeParse

• safeParse(data, params?): SafeParseReturnType<Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][], arrayOutputType<T, Cardinality>>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

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

safeParseAsync

• safeParseAsync(data, params?): Promise<SafeParseReturnType<Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][], arrayOutputType<T, Cardinality>>>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

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

superRefine

• superRefine<RefinedOutput>(refinement): ZodEffects<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: arrayOutputType<T, Cardinality>, ctx: RefinementCtx) => arg is RefinedOutput)
    • • (arg, ctx): arg is RefinedOutput

      • Parameters

        • arg: arrayOutputType<T, Cardinality>
        • ctx: RefinementCtx

        Returns arg is RefinedOutput

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

• superRefine(refinement): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][]>

• Parameters

  • refinement: ((arg: arrayOutputType<T, Cardinality>, ctx: RefinementCtx) => void)
    • • (arg, ctx): void

      • Parameters

        • arg: arrayOutputType<T, Cardinality>
        • ctx: RefinementCtx

        Returns void

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

• superRefine(refinement): ZodEffects<ZodArray<T, Cardinality>, arrayOutputType<T, Cardinality>, Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][]>

• Parameters

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

      • Parameters

        • arg: arrayOutputType<T, Cardinality>
        • ctx: RefinementCtx

        Returns Promise<void>

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

transform

• transform<NewOut>(transform): ZodEffects<ZodArray<T, Cardinality>, NewOut, Cardinality extends "atleastone"
      ? [T["_input"], ...T["_input"][]]
      : T["_input"][]>

• Type Parameters

  • NewOut

  Parameters

  • transform: ((arg: arrayOutputType<T, Cardinality>, ctx: RefinementCtx) => NewOut | Promise<NewOut>)
    • • (arg, ctx): NewOut | Promise<NewOut>

      • Parameters

        • arg: arrayOutputType<T, Cardinality>
        • ctx: RefinementCtx

        Returns NewOut | Promise<NewOut>

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