Interface ZodTuple<T, Rest>

_def

_input

_output

_zod

~standard

def

Optionaldescription

spa

type

and

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

  Type Parameters

  • T extends SomeType

  Parameters

  • incoming: T

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

array

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

  Returns ZodArray<ZodTuple<T, Rest>>

brand

• brand<T extends PropertyKey = PropertyKey>(
      value?: T,
  ): PropertyKey extends T
      ? ZodTuple<T, Rest>
      : $ZodBranded<ZodTuple<T, Rest>, T>

  Type Parameters

  • T extends PropertyKey = PropertyKey

  Parameters

  • Optionalvalue: T

  Returns PropertyKey extends T ? ZodTuple<T, Rest> : $ZodBranded<ZodTuple<T, Rest>, T>

catch

• catch(
      def: [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  ): ZodCatch<ZodTuple<T, Rest>>

  Parameters

  • def: [
        ...TupleOutputTypeWithOptionals<T>[],
        ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
    ]

  Returns ZodCatch<ZodTuple<T, Rest>>

• catch(
      def: (
          ctx: $ZodCatchCtx,
      ) => [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  ): ZodCatch<ZodTuple<T, Rest>>

  Parameters

  • def: (
        ctx: $ZodCatchCtx,
    ) => [
        ...TupleOutputTypeWithOptionals<T>[],
        ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
    ]

  Returns ZodCatch<ZodTuple<T, Rest>>

check

• check(
      ...checks: (
          | CheckFn<
              [
                  ...TupleOutputTypeWithOptionals<T>[],
                  ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
              ],
          >
          | $ZodCheck<
              [
                  ...TupleOutputTypeWithOptionals<T>[],
                  ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
              ],
          >
      )[],
  ): this

  Parameters

  • ...checks: (
        | CheckFn<
            [
                ...TupleOutputTypeWithOptionals<T>[],
                ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
            ],
        >
        | $ZodCheck<
            [
                ...TupleOutputTypeWithOptionals<T>[],
                ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
            ],
        >
    )[]

  Returns this

clone

• clone(def?: $ZodTupleDef<T, Rest>, params?: { parent: boolean }): this

  Parameters

  • Optionaldef: $ZodTupleDef<T, Rest>
  • Optionalparams: { parent: boolean }

  Returns this

default

• default(
      def: [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  ): ZodDefault<ZodTuple<T, Rest>>

  Parameters

  • def: [
        ...TupleOutputTypeWithOptionals<T>[],
        ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
    ]

  Returns ZodDefault<ZodTuple<T, Rest>>

• default(
      def: () => NoUndefined<
          [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
      >,
  ): ZodDefault<ZodTuple<T, Rest>>

  Parameters

  • def: () => NoUndefined<
        [
            ...TupleOutputTypeWithOptionals<T>[],
            ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
        ],
    >

  Returns ZodDefault<ZodTuple<T, Rest>>

describe

• describe(description: string): this

  Returns a new instance that has been registered in z.globalRegistry with the specified description

  Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

  Returns boolean

  Deprecated

  Try safe-parsing null (this is what isNullable does internally):

  const schema = z.string().nullable();
  const isNullable = schema.safeParse(null).success; // true
  Copy

isOptional

• isOptional(): boolean

  Returns boolean

  Deprecated

  Try safe-parsing undefined (this is what isOptional does internally):

  const schema = z.string().optional();
  const isOptional = schema.safeParse(undefined).success; // true
  Copy

meta

• meta(): | undefined
  | {
      deprecated?: boolean;
      description?: string;
      example?: unknown;
      examples?: | unknown[]
      | { [key: string]: { value: unknown; [key: string]: unknown } };
      id?: string;
      title?: string;
      [key: string]: unknown;
  }

  Returns the metadata associated with this instance in z.globalRegistry

  Returns
      | undefined
      | {
          deprecated?: boolean;
          description?: string;
          example?: unknown;
          examples?: | unknown[]
          | { [key: string]: { value: unknown; [key: string]: unknown } };
          id?: string;
          title?: string;
          [key: string]: unknown;
      }
• meta(
      data: {
          deprecated?: boolean;
          description?: string;
          example?: unknown;
          examples?:
              | unknown[]
              | { [key: string]: { value: unknown; [key: string]: unknown } };
          id?: string;
          title?: string;
          [key: string]: unknown;
      },
  ): this

  Returns a new instance that has been registered in z.globalRegistry with the specified metadata

  Parameters

  • data: {
        deprecated?: boolean;
        description?: string;
        example?: unknown;
        examples?:
            | unknown[]
            | { [key: string]: { value: unknown; [key: string]: unknown } };
        id?: string;
        title?: string;
        [key: string]: unknown;
    }

  Returns this

nonoptional

• nonoptional(
      params?:
          | string
          | {
              error?: string
              | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
              message?: string;
          },
  ): ZodNonOptional<ZodTuple<T, Rest>>

  Parameters

  • Optionalparams:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        }
    • string
    • {
          error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
          message?: string;
      }

      • Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>

      • Optionalmessage?: string

        Deprecated

        This parameter is deprecated. Use error instead.

  Returns ZodNonOptional<ZodTuple<T, Rest>>

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

  Type Parameters

  • T extends SomeType

  Parameters

  • option: T

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

overwrite

• overwrite(
      fn: (
          x: [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
      ) => [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  ): this

  Parameters

  • fn: (
        x: [
            ...TupleOutputTypeWithOptionals<T>[],
            ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
        ],
    ) => [
        ...TupleOutputTypeWithOptionals<T>[],
        ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
    ]

  Returns this

parse

• parse(
      data: unknown,
      params?: ParseContext<$ZodIssue>,
  ): [
      ...TupleOutputTypeWithOptionals<T>[],
      ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
  ]

  Parameters

  • data: unknown
  • Optionalparams: ParseContext<$ZodIssue>

  Returns [
      ...TupleOutputTypeWithOptionals<T>[],
      ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
  ]

parseAsync

• parseAsync(
      data: unknown,
      params?: ParseContext<$ZodIssue>,
  ): Promise<
      [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  >

  Parameters

  • data: unknown
  • Optionalparams: ParseContext<$ZodIssue>

  Returns Promise<
      [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  >

pipe

• pipe<
      T extends
          $ZodType<
              any,
              [
                  ...TupleOutputTypeWithOptionals<T>[],
                  ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
              ],
              $ZodTypeInternals<
                  any,
                  [
                      ...TupleOutputTypeWithOptionals<T>[],
                      ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
                  ],
              >,
          >,
  >(
      target:
          | T
          | $ZodType<
              any,
              [
                  ...TupleOutputTypeWithOptionals<T>[],
                  ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
              ],
              $ZodTypeInternals<
                  any,
                  [
                      ...TupleOutputTypeWithOptionals<T>[],
                      ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
                  ],
              >,
          >,
  ): ZodPipe<ZodTuple<T, Rest>, T>

  Type Parameters

  • T extends $ZodType<
        any,
        [
            ...TupleOutputTypeWithOptionals<T>[],
            ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
        ],
        $ZodTypeInternals<
            any,
            [
                ...TupleOutputTypeWithOptionals<T>[],
                ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
            ],
        >,
    >

  Parameters

  • target:
        | T
        | $ZodType<
            any,
            [
                ...TupleOutputTypeWithOptionals<T>[],
                ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
            ],
            $ZodTypeInternals<
                any,
                [
                    ...TupleOutputTypeWithOptionals<T>[],
                    ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
                ],
            >,
        >

  Returns ZodPipe<ZodTuple<T, Rest>, T>

prefault

• prefault(
      def: () => [
          ...TupleInputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? input<Rest<Rest>>[] : [])[],
      ],
  ): ZodPrefault<ZodTuple<T, Rest>>

  Parameters

  • def: () => [
        ...TupleInputTypeWithOptionals<T>[],
        ...(Rest extends SomeType ? input<Rest<Rest>>[] : [])[],
    ]

  Returns ZodPrefault<ZodTuple<T, Rest>>

• prefault(
      def: [
          ...TupleInputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? input<Rest<Rest>>[] : [])[],
      ],
  ): ZodPrefault<ZodTuple<T, Rest>>

  Parameters

  • def: [
        ...TupleInputTypeWithOptionals<T>[],
        ...(Rest extends SomeType ? input<Rest<Rest>>[] : [])[],
    ]

  Returns ZodPrefault<ZodTuple<T, Rest>>

readonly

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

  Returns ZodReadonly<ZodTuple<T, Rest>>

refine

• refine(
      check: (
          arg: [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
      ) => unknown,
      params?:
          | string
          | {
              abort?: boolean;
              error?: string
              | $ZodErrorMap<NonNullable<$ZodIssue>>;
              message?: string;
              params?: Record<string, any>;
              path?: PropertyKey[];
          },
  ): this

  Parameters

  • check: (
        arg: [
            ...TupleOutputTypeWithOptionals<T>[],
            ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
        ],
    ) => unknown
  • Optionalparams:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<NonNullable<$ZodIssue>>;
            message?: string;
            params?: Record<string, any>;
            path?: PropertyKey[];
        }
    • string
    • {
          abort?: boolean;
          error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
          message?: string;
          params?: Record<string, any>;
          path?: PropertyKey[];
      }

      • Optionalabort?: boolean

        If true, no later checks will be executed if this check fails. Default false.

      • Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>

      • Optionalmessage?: string

        Deprecated

        This parameter is deprecated. Use error instead.

      • Optionalparams?: Record<string, any>

      • Optionalpath?: PropertyKey[]

  Returns this

register

• register<
      R extends
          $ZodRegistry<
              MetadataType,
              $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
          >,
  >(
      registry: R,
      ...meta: ZodTuple<T, Rest> extends R["_schema"]
          ? undefined extends R["_meta"]
              ? [$replace<R["_meta"], R["_schema"] & ZodTuple<T, Rest>>?]
              : [$replace<R["_meta"], R["_schema"] & ZodTuple<T, Rest>>]
          : ["Incompatible schema"],
  ): this

  Type Parameters

  • R extends $ZodRegistry<
        MetadataType,
        $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
    >

  Parameters

  • registry: R
  • ...meta: ZodTuple<T, Rest> extends R["_schema"]
        ? undefined extends R["_meta"]
            ? [$replace<R["_meta"], R["_schema"] & ZodTuple<T, Rest>>?]
            : [$replace<R["_meta"], R["_schema"] & ZodTuple<T, Rest>>]
        : ["Incompatible schema"]

  Returns this

safeParse

• safeParse(
      data: unknown,
      params?: ParseContext<$ZodIssue>,
  ): ZodSafeParseResult<
      [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  >

  Parameters

  • data: unknown
  • Optionalparams: ParseContext<$ZodIssue>

  Returns ZodSafeParseResult<
      [
          ...TupleOutputTypeWithOptionals<T>[],
          ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
      ],
  >

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: ParseContext<$ZodIssue>,
  ): Promise<
      ZodSafeParseResult<
          [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
      >,
  >

  Parameters

  • data: unknown
  • Optionalparams: ParseContext<$ZodIssue>

  Returns Promise<
      ZodSafeParseResult<
          [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
      >,
  >

superRefine

• superRefine(
      refinement: (
          arg: [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
          ctx: RefinementCtx<
              [
                  ...TupleOutputTypeWithOptionals<T>[],
                  ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
              ],
          >,
      ) => void | Promise<void>,
  ): this

  Parameters

  • refinement: (
        arg: [
            ...TupleOutputTypeWithOptionals<T>[],
            ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
        ],
        ctx: RefinementCtx<
            [
                ...TupleOutputTypeWithOptionals<T>[],
                ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
            ],
        >,
    ) => void | Promise<void>

  Returns this

  Deprecated

  Use .check() instead.

transform

• transform<NewOut>(
      transform: (
          arg: [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
          ctx: RefinementCtx<
              [
                  ...TupleOutputTypeWithOptionals<T>[],
                  ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
              ],
          >,
      ) => NewOut | Promise<NewOut>,
  ): ZodPipe<
      ZodTuple<T, Rest>,
      ZodTransform<
          Awaited<NewOut>,
          [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
      >,
  >

  Type Parameters

  • NewOut

  Parameters

  • transform: (
        arg: [
            ...TupleOutputTypeWithOptionals<T>[],
            ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
        ],
        ctx: RefinementCtx<
            [
                ...TupleOutputTypeWithOptionals<T>[],
                ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
            ],
        >,
    ) => NewOut | Promise<NewOut>

  Returns ZodPipe<
      ZodTuple<T, Rest>,
      ZodTransform<
          Awaited<NewOut>,
          [
              ...TupleOutputTypeWithOptionals<T>[],
              ...(Rest extends SomeType ? output<Rest<Rest>>[] : [])[],
          ],
      >,
  >