Class ZodTuple<T, Rest>

constructor

• new ZodTuple<T, Rest>(def): ZodTuple<T, Rest>

• Type Parameters

  • T extends [] | [ZodTypeAny, ...ZodTypeAny[]] = [ZodTypeAny, ...ZodTypeAny[]]

  • Rest extends null | ZodTypeAny = null

  Parameters

  • def: ZodTupleDef<T, Rest>

  Returns ZodTuple<T, Rest>

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

  • Optional ctx: ParseContext

  Returns ParseContext

_getType

• _getType(input): string

• Parameters

  • input: ParseInput

  Returns string

_parseAsync

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

• Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<OutputTypeOfTupleWithRest<T, Rest>>

_parseSync

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

• Parameters

  • input: ParseInput

  Returns SyncParseReturnType<OutputTypeOfTupleWithRest<T, Rest>>

_processInputParams

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

• Parameters

  • input: ParseInput

  Returns {
      ctx: ParseContext;
      status: ParseStatus;
  }

  • ctx: ParseContext

  • status: ParseStatus

_refinement

• _refinement(refinement): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

• Parameters

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

    • • (arg, ctx): any

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        • ctx: RefinementCtx

        Returns any

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

and

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

• Returns ZodArray<ZodTuple<T, Rest>, "many">

brand

• brand<B>(brand?): ZodBranded<ZodTuple<T, Rest>, B>

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optional brand: B

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

catch

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

• Parameters

  • def: OutputTypeOfTupleWithRest<T, Rest>

  Returns ZodCatch<ZodTuple<T, Rest>>

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

• Parameters

  • def: ((ctx) => OutputTypeOfTupleWithRest<T, Rest>)

    • • (ctx): OutputTypeOfTupleWithRest<T, Rest>

      • Parameters

        • ctx: {
              error: ZodError<any>;
              input: InputTypeOfTupleWithRest<T, Rest>;
          }

          • error: ZodError<any>

          • input: InputTypeOfTupleWithRest<T, Rest>

        Returns OutputTypeOfTupleWithRest<T, Rest>

  Returns ZodCatch<ZodTuple<T, Rest>>

default

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

• Parameters

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

  Returns ZodDefault<ZodTuple<T, Rest>>

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

• Parameters

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

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

      • Returns noUndefined<InputTypeOfTupleWithRest<T, Rest>>

  Returns ZodDefault<ZodTuple<T, Rest>>

describe

• describe(description): ZodTuple<T, Rest>

• Parameters

  • description: string

  Returns ZodTuple<T, Rest>

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>(option): ZodUnion<[ZodTuple<T, Rest>, T]>

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

parse

• parse(data, params?): OutputTypeOfTupleWithRest<T, Rest>

• Parameters

  • data: unknown

  • Optional params: Partial<ParseParams>

  Returns OutputTypeOfTupleWithRest<T, Rest>

parseAsync

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

• Parameters

  • data: unknown

  • Optional params: Partial<ParseParams>

  Returns Promise<OutputTypeOfTupleWithRest<T, Rest>>

pipe

• pipe<T>(target): 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>>

refine

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

    • • (arg): arg is RefinedOutput

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        Returns arg is RefinedOutput

  • Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)

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

• refine(check, message?): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

• Parameters

  • check: ((arg) => unknown)

    • • (arg): unknown

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        Returns unknown

  • Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)

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

refinement

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

    • • (arg): arg is RefinedOutput

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        Returns arg is RefinedOutput

  • refinementData: IssueData | ((arg, ctx) => IssueData)

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

• refinement(check, refinementData): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

• Parameters

  • check: ((arg) => boolean)

    • • (arg): boolean

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        Returns boolean

  • refinementData: IssueData | ((arg, ctx) => IssueData)

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

safeParse

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

• Parameters

  • data: unknown

  • Optional params: Partial<ParseParams>

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

safeParseAsync

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

• Parameters

  • data: unknown

  • Optional params: Partial<ParseParams>

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

superRefine

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

    • • (arg, ctx): arg is RefinedOutput

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        • ctx: RefinementCtx

        Returns arg is RefinedOutput

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

• superRefine(refinement): ZodEffects<ZodTuple<T, Rest>, OutputTypeOfTupleWithRest<T, Rest>, InputTypeOfTupleWithRest<T, Rest>>

• Parameters

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

    • • (arg, ctx): void

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        • ctx: RefinementCtx

        Returns void

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

transform

• transform<NewOut>(transform): ZodEffects<ZodTuple<T, Rest>, NewOut, InputTypeOfTupleWithRest<T, Rest>>

• Type Parameters

  • NewOut

  Parameters

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

    • • (arg, ctx): NewOut | Promise<NewOut>

      • Parameters

        • arg: OutputTypeOfTupleWithRest<T, Rest>

        • ctx: RefinementCtx

        Returns NewOut | Promise<NewOut>

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