Class ZodTuple<T, Rest>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

spa

description

• get description(): string | undefined

  Returns string | undefined

_getOrReturnCtx

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

  Parameters

  • input: z.ParseInput
  • Optionalctx: z.ParseContext

  Returns z.ParseContext

_getType

• _getType(input: z.ParseInput): string

  Parameters

  • input: z.ParseInput

  Returns string

_parseAsync

• _parseAsync(
      input: z.ParseInput,
  ): z.AsyncParseReturnType<z.OutputTypeOfTupleWithRest<T, Rest>>

  Parameters

  • input: z.ParseInput

  Returns z.AsyncParseReturnType<z.OutputTypeOfTupleWithRest<T, Rest>>

_parseSync

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

  Parameters

  • input: z.ParseInput

  Returns z.SyncParseReturnType<z.OutputTypeOfTupleWithRest<T, Rest>>

_processInputParams

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

  Parameters

  • input: z.ParseInput

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

_refinement

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

  Parameters

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

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

~validate

• "~validate"(
      data: unknown,
  ):
      | Result<z.OutputTypeOfTupleWithRest<T, Rest>>
      | Promise<Result<z.OutputTypeOfTupleWithRest<T, Rest>>>

  Parameters

  • data: unknown

  Returns
      | Result<z.OutputTypeOfTupleWithRest<T, Rest>>
      | Promise<Result<z.OutputTypeOfTupleWithRest<T, Rest>>>

and

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

  Type Parameters

  • T extends z.ZodTypeAny

  Parameters

  • incoming: T

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

array

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

  Returns z.ZodArray<z.ZodTuple<T, Rest>>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

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

catch

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

  Parameters

  • def: z.OutputTypeOfTupleWithRest

  Returns z.ZodCatch<z.ZodTuple<T, Rest>>

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

  Parameters

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

  Returns z.ZodCatch<z.ZodTuple<T, Rest>>

default

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

  Parameters

  • def: z.util.noUndefined<z.InputTypeOfTupleWithRest<T, Rest>>

  Returns z.ZodDefault<z.ZodTuple<T, Rest>>

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

  Parameters

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

  Returns z.ZodDefault<z.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(): z.ZodNullable<z.ZodTuple<T, Rest>>

  Returns z.ZodNullable<z.ZodTuple<T, Rest>>

nullish

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

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

optional

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

  Returns z.ZodOptional<z.ZodTuple<T, Rest>>

or

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

  Type Parameters

  • T extends z.ZodTypeAny

  Parameters

  • option: T

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

parse

• parse(
      data: unknown,
      params?: z.util.InexactPartial<z.ParseParams>,
  ): z.OutputTypeOfTupleWithRest

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

  Returns z.OutputTypeOfTupleWithRest

parseAsync

• parseAsync(
      data: unknown,
      params?: z.util.InexactPartial<z.ParseParams>,
  ): Promise<z.OutputTypeOfTupleWithRest<T, Rest>>

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

  Returns Promise<z.OutputTypeOfTupleWithRest<T, Rest>>

pipe

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

  Type Parameters

  • T extends z.ZodTypeAny

  Parameters

  • target: T

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

promise

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

  Returns z.ZodPromise<z.ZodTuple<T, Rest>>

readonly

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

  Returns z.ZodReadonly<z.ZodTuple<T, Rest>>

refine

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

  Type Parameters

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

  Parameters

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

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

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

  Parameters

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

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

refinement

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

  Type Parameters

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

  Parameters

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

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

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

  Parameters

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

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

safeParse

• safeParse(
      data: unknown,
      params?: z.util.InexactPartial<z.ParseParams>,
  ): z.SafeParseReturnType<
      z.InputTypeOfTupleWithRest<T, Rest>,
      z.OutputTypeOfTupleWithRest<T, Rest>,
  >

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

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

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: z.util.InexactPartial<z.ParseParams>,
  ): Promise<
      z.SafeParseReturnType<
          z.InputTypeOfTupleWithRest<T, Rest>,
          z.OutputTypeOfTupleWithRest<T, Rest>,
      >,
  >

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

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

superRefine

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

  Type Parameters

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

  Parameters

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

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

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

  Parameters

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

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

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

  Parameters

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

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

transform

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

  Type Parameters

  • NewOut

  Parameters

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

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