Class ZodTuple<T, Rest>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

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

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<OutputTypeOfTupleWithRest<T, Rest>>

_parseSync

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

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<OutputTypeOfTupleWithRest<T, Rest>>

_processInputParams

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

  Parameters

  • input: ParseInput

  Returns { ctx: ParseContext; status: ParseStatus }

_refinement

• _refinement(
      refinement: (arg: OutputTypeOfTupleWithRest, ctx: RefinementCtx) => any,
  ): ZodEffects<
      ZodTuple<T, Rest>,
      OutputTypeOfTupleWithRest<T, Rest>,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Parameters

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

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

and

• and<T extends ZodTypeAny>(incoming: T): ZodIntersection<ZodTuple<T, Rest>, T>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodTuple<T, Rest>, T>

array

• array(): ZodArray<ZodTuple<T, Rest>>

  Returns ZodArray<ZodTuple<T, Rest>>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodTuple<T, Rest>, B>

catch

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

  Parameters

  • def: OutputTypeOfTupleWithRest

  Returns ZodCatch<ZodTuple<T, Rest>>

• catch(
      def: (
          ctx: { error: ZodError; input: InputTypeOfTupleWithRest },
      ) => OutputTypeOfTupleWithRest,
  ): ZodCatch<ZodTuple<T, Rest>>

  Parameters

  • def: (
        ctx: { error: ZodError; input: InputTypeOfTupleWithRest },
    ) => OutputTypeOfTupleWithRest

  Returns ZodCatch<ZodTuple<T, Rest>>

default

• default(
      def: noUndefined<InputTypeOfTupleWithRest<T, Rest>>,
  ): ZodDefault<ZodTuple<T, Rest>>

  Parameters

  • def: noUndefined<InputTypeOfTupleWithRest<T, Rest>>

  Returns ZodDefault<ZodTuple<T, Rest>>

• default(
      def: () => noUndefined<InputTypeOfTupleWithRest<T, Rest>>,
  ): ZodDefault<ZodTuple<T, Rest>>

  Parameters

  • def: () => noUndefined<InputTypeOfTupleWithRest<T, Rest>>

  Returns ZodDefault<ZodTuple<T, Rest>>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

  Returns boolean

isOptional

• isOptional(): boolean

  Returns boolean

nullable

• nullable(): ZodNullable<ZodTuple<T, Rest>>

  Returns ZodNullable<ZodTuple<T, Rest>>

nullish

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

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

optional

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

  Returns ZodOptional<ZodTuple<T, Rest>>

or

• or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodTuple<T, Rest>, T]>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

parse

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

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns OutputTypeOfTupleWithRest

parseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<OutputTypeOfTupleWithRest<T, Rest>>

pipe

• pipe<T extends ZodTypeAny>(target: T): ZodPipeline<ZodTuple<T, Rest>, T>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodTuple<T, Rest>, T>

promise

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

  Returns ZodPromise<ZodTuple<T, Rest>>

readonly

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

  Returns ZodReadonly<ZodTuple<T, Rest>>

refine

• refine<
      RefinedOutput extends
          | [
              ...AssertArray<
                  {
                      [k in string
                      | number
                      | symbol]: T[k] extends ZodType<any, any, any>
                          ? any[any]["_output"]
                          : never
                  },
              >[],
              ...any[],
          ]
          | any[] & {
              [k in string
              | number
              | symbol]: T[k] extends ZodType<any, any, any>
                  ? any[any]["_output"]
                  : never
          },
  >(
      check: (arg: OutputTypeOfTupleWithRest) => arg is RefinedOutput,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | ((arg: OutputTypeOfTupleWithRest) => CustomErrorParams),
  ): ZodEffects<
      ZodTuple<T, Rest>,
      RefinedOutput,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Type Parameters

  • RefinedOutput extends
        | [
            ...AssertArray<
                {
                    [k in string
                    | number
                    | symbol]: T[k] extends ZodType<any, any, any>
                        ? any[any]["_output"]
                        : never
                },
            >[],
            ...any[],
        ]
        | any[] & {
            [k in string
            | number
            | symbol]: T[k] extends ZodType<any, any, any>
                ? any[any]["_output"]
                : never
        }

  Parameters

  • check: (arg: OutputTypeOfTupleWithRest) => arg is RefinedOutput
  • Optionalmessage:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | ((arg: OutputTypeOfTupleWithRest) => CustomErrorParams)

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

• refine(
      check: (arg: OutputTypeOfTupleWithRest) => unknown,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | ((arg: OutputTypeOfTupleWithRest) => CustomErrorParams),
  ): ZodEffects<
      ZodTuple<T, Rest>,
      OutputTypeOfTupleWithRest<T, Rest>,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Parameters

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

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

refinement

• refinement<
      RefinedOutput extends
          | [
              ...AssertArray<
                  {
                      [k in string
                      | number
                      | symbol]: T[k] extends ZodType<any, any, any>
                          ? any[any]["_output"]
                          : never
                  },
              >[],
              ...any[],
          ]
          | any[] & {
              [k in string
              | number
              | symbol]: T[k] extends ZodType<any, any, any>
                  ? any[any]["_output"]
                  : never
          },
  >(
      check: (arg: OutputTypeOfTupleWithRest) => arg is RefinedOutput,
      refinementData:
          | IssueData
          | ((arg: OutputTypeOfTupleWithRest, ctx: RefinementCtx) => IssueData),
  ): ZodEffects<
      ZodTuple<T, Rest>,
      RefinedOutput,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Type Parameters

  • RefinedOutput extends
        | [
            ...AssertArray<
                {
                    [k in string
                    | number
                    | symbol]: T[k] extends ZodType<any, any, any>
                        ? any[any]["_output"]
                        : never
                },
            >[],
            ...any[],
        ]
        | any[] & {
            [k in string
            | number
            | symbol]: T[k] extends ZodType<any, any, any>
                ? any[any]["_output"]
                : never
        }

  Parameters

  • check: (arg: OutputTypeOfTupleWithRest) => arg is RefinedOutput
  • refinementData: IssueData | ((arg: OutputTypeOfTupleWithRest, ctx: RefinementCtx) => IssueData)

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

• refinement(
      check: (arg: OutputTypeOfTupleWithRest) => boolean,
      refinementData:
          | IssueData
          | ((arg: OutputTypeOfTupleWithRest, ctx: RefinementCtx) => IssueData),
  ): ZodEffects<
      ZodTuple<T, Rest>,
      OutputTypeOfTupleWithRest<T, Rest>,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Parameters

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

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

safeParse

• safeParse(
      data: unknown,
      params?: Partial<ParseParams>,
  ): SafeParseReturnType<
      InputTypeOfTupleWithRest<T, Rest>,
      OutputTypeOfTupleWithRest<T, Rest>,
  >

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

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

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: Partial<ParseParams>,
  ): Promise<
      SafeParseReturnType<
          InputTypeOfTupleWithRest<T, Rest>,
          OutputTypeOfTupleWithRest<T, Rest>,
      >,
  >

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

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

superRefine

• superRefine<
      RefinedOutput extends
          | [
              ...AssertArray<
                  {
                      [k in string
                      | number
                      | symbol]: T[k] extends ZodType<any, any, any>
                          ? any[any]["_output"]
                          : never
                  },
              >[],
              ...any[],
          ]
          | any[] & {
              [k in string
              | number
              | symbol]: T[k] extends ZodType<any, any, any>
                  ? any[any]["_output"]
                  : never
          },
  >(
      refinement: (
          arg: OutputTypeOfTupleWithRest,
          ctx: RefinementCtx,
      ) => arg is RefinedOutput,
  ): ZodEffects<
      ZodTuple<T, Rest>,
      RefinedOutput,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Type Parameters

  • RefinedOutput extends
        | [
            ...AssertArray<
                {
                    [k in string
                    | number
                    | symbol]: T[k] extends ZodType<any, any, any>
                        ? any[any]["_output"]
                        : never
                },
            >[],
            ...any[],
        ]
        | any[] & {
            [k in string
            | number
            | symbol]: T[k] extends ZodType<any, any, any>
                ? any[any]["_output"]
                : never
        }

  Parameters

  • refinement: (arg: OutputTypeOfTupleWithRest, ctx: RefinementCtx) => arg is RefinedOutput

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

• superRefine(
      refinement: (arg: OutputTypeOfTupleWithRest, ctx: RefinementCtx) => void,
  ): ZodEffects<
      ZodTuple<T, Rest>,
      OutputTypeOfTupleWithRest<T, Rest>,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Parameters

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

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

• superRefine(
      refinement: (
          arg: OutputTypeOfTupleWithRest,
          ctx: RefinementCtx,
      ) => Promise<void>,
  ): ZodEffects<
      ZodTuple<T, Rest>,
      OutputTypeOfTupleWithRest<T, Rest>,
      InputTypeOfTupleWithRest<T, Rest>,
  >

  Parameters

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

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

transform

• transform<NewOut>(
      transform: (
          arg: OutputTypeOfTupleWithRest,
          ctx: RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): ZodEffects<ZodTuple<T, Rest>, NewOut>

  Type Parameters

  • NewOut

  Parameters

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

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