Class ZodArray<T, Cardinality>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

description

• get description(): string | undefined

  Returns string | undefined

_getOrReturnCtx

• _getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext

  Parameters

  • input: ParseInput
  • Optionalctx: ParseContext

  Returns ParseContext

_getType

• _getType(input: ParseInput): string

  Parameters

  • input: ParseInput

  Returns string

_parseAsync

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

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<arrayOutputType<T, Cardinality>>

_parseSync

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

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<arrayOutputType<T, Cardinality>>

_processInputParams

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

  Parameters

  • input: ParseInput

  Returns { ctx: ParseContext; status: ParseStatus }

_refinement

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

  Parameters

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

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

and

• and<T extends ZodTypeAny>(
      incoming: T,
  ): 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>>

  Returns ZodArray<ZodArray<T, Cardinality>>

brand

• brand<B extends string | number | symbol>(
      brand?: B,
  ): ZodBranded<ZodArray<T, Cardinality>, B>

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

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

catch

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

  Parameters

  • def: arrayOutputType

  Returns ZodCatch<ZodArray<T, Cardinality>>

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

  Parameters

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

  Returns ZodCatch<ZodArray<T, Cardinality>>

default

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

  Parameters

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

  Returns ZodDefault<ZodArray<T, Cardinality>>

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

  Parameters

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

  Returns ZodDefault<ZodArray<T, Cardinality>>

describe

• describe(description: string): 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 extends ZodTypeAny>(option: T): ZodUnion<[ZodArray<T, Cardinality>, T]>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

parse

• parse(data: unknown, params?: Partial<ParseParams>): arrayOutputType

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns arrayOutputType

parseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<arrayOutputType<T, Cardinality>>

pipe

• pipe<T extends ZodTypeAny>(target: T): 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 extends [T["_output"], ...T["_output"][]] | T["_output"][]>(
      check: (arg: arrayOutputType) => arg is RefinedOutput,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | ((arg: arrayOutputType) => CustomErrorParams),
  ): 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) => arg is RefinedOutput
  • Optionalmessage:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: arrayOutputType) => CustomErrorParams)

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

• refine(
      check: (arg: arrayOutputType) => unknown,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | ((arg: arrayOutputType) => CustomErrorParams),
  ): ZodEffects<
      ZodArray<T, Cardinality>,
      arrayOutputType<T, Cardinality>,
      Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][],
  >

  Parameters

  • check: (arg: arrayOutputType) => unknown
  • Optionalmessage:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: arrayOutputType) => CustomErrorParams)

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

refinement

• refinement<
      RefinedOutput extends [T["_output"], ...T["_output"][]]
      | T["_output"][],
  >(
      check: (arg: arrayOutputType) => arg is RefinedOutput,
      refinementData:
          | IssueData
          | ((arg: arrayOutputType, ctx: RefinementCtx) => IssueData),
  ): 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) => arg is RefinedOutput
  • refinementData: IssueData | ((arg: arrayOutputType, ctx: RefinementCtx) => IssueData)

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

• refinement(
      check: (arg: arrayOutputType) => boolean,
      refinementData:
          | IssueData
          | ((arg: arrayOutputType, ctx: RefinementCtx) => IssueData),
  ): ZodEffects<
      ZodArray<T, Cardinality>,
      arrayOutputType<T, Cardinality>,
      Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][],
  >

  Parameters

  • check: (arg: arrayOutputType) => boolean
  • refinementData: IssueData | ((arg: arrayOutputType, ctx: RefinementCtx) => IssueData)

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

safeParse

• safeParse(
      data: unknown,
      params?: Partial<ParseParams>,
  ): 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: unknown,
      params?: Partial<ParseParams>,
  ): 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 extends [T["_output"], ...T["_output"][]]
      | T["_output"][],
  >(
      refinement: (
          arg: arrayOutputType,
          ctx: RefinementCtx,
      ) => arg is RefinedOutput,
  ): 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, ctx: RefinementCtx) => arg is RefinedOutput

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

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

  Parameters

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

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

• superRefine(
      refinement: (arg: arrayOutputType, ctx: RefinementCtx) => Promise<void>,
  ): ZodEffects<
      ZodArray<T, Cardinality>,
      arrayOutputType<T, Cardinality>,
      Cardinality extends "atleastone"
          ? [T["_input"], ...T["_input"][]]
          : T["_input"][],
  >

  Parameters

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

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

transform

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

  Type Parameters

  • NewOut

  Parameters

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

  Returns ZodEffects<ZodArray<T, Cardinality>, NewOut>