Class ZodType<Output, Def, Input>Abstract

constructor

• new ZodType<Output, Def extends ZodTypeDef, Input>(def: Def): ZodType<Output, Def, Input>

• Type Parameters

  • Output = any
  • Def extends ZodTypeDef = ZodTypeDef
  • Input = Output

  Parameters

  • def: Def

  Returns ZodType<Output, Def, Input>

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

description

• get description(): undefined | string

• Returns undefined | string

_getOrReturnCtx

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

• Parameters

  • input: ParseInput
  • Optional ctx: ParseContext

  Returns ParseContext

_getType

• _getType(input: ParseInput): string

• Parameters

  • input: ParseInput

  Returns string

Abstract _parse

• _parse(input: ParseInput): ParseReturnType<Output>

• Parameters

  • input: ParseInput

  Returns ParseReturnType<Output>

_parseAsync

• _parseAsync(input: ParseInput): AsyncParseReturnType<Output>

• Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<Output>

_parseSync

• _parseSync(input: ParseInput): SyncParseReturnType<Output>

• Parameters

  • input: ParseInput

  Returns SyncParseReturnType<Output>

_processInputParams

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

• Parameters

  • input: ParseInput

  Returns {
      ctx: ParseContext;
      status: ParseStatus;
  }

  • ctx: ParseContext

  • status: ParseStatus

_refinement

• _refinement(refinement: ((arg: Output, ctx: RefinementCtx) => any)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>

• Parameters

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

      • Parameters

        • arg: Output
        • ctx: RefinementCtx

        Returns any

  Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

and

• and<T extends ZodTypeAny>(incoming: T): ZodIntersection<ZodType<Output, Def, Input>, T>

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodType<Output, Def, Input>, T>

array

• array(): ZodArray<ZodType<Output, Def, Input>, "many">

• Returns ZodArray<ZodType<Output, Def, Input>, "many">

brand

• brand<B extends string | number | symbol>(brand?: B): ZodBranded<ZodType<Output, Def, Input>, B>

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optional brand: B

  Returns ZodBranded<ZodType<Output, Def, Input>, B>

catch

• catch(def: Output): ZodCatch<ZodType<Output, Def, Input>>

• Parameters

  • def: Output

  Returns ZodCatch<ZodType<Output, Def, Input>>

• catch(def: ((ctx: {
      error: ZodError<any>;
      input: Input;
  }) => Output)): ZodCatch<ZodType<Output, Def, Input>>

• Parameters

  • def: ((ctx: {
        error: ZodError<any>;
        input: Input;
    }) => Output)
    • • (ctx: {
            error: ZodError<any>;
            input: Input;
        }): Output

      • Parameters

        • ctx: {
              error: ZodError<any>;
              input: Input;
          }

          • error: ZodError<any>

          • input: Input

        Returns Output

  Returns ZodCatch<ZodType<Output, Def, Input>>

default

• default(def: noUndefined<Input>): ZodDefault<ZodType<Output, Def, Input>>

• Parameters

  • def: noUndefined<Input>

  Returns ZodDefault<ZodType<Output, Def, Input>>

• default(def: (() => noUndefined<Input>)): ZodDefault<ZodType<Output, Def, Input>>

• Parameters

  • def: (() => noUndefined<Input>)
    • • (): noUndefined<Input>

      • Returns noUndefined<Input>

  Returns ZodDefault<ZodType<Output, Def, Input>>

describe

• describe(description: string): this

• Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

• Returns boolean

isOptional

• isOptional(): boolean

• Returns boolean

nullable

• nullable(): ZodNullable<ZodType<Output, Def, Input>>

• Returns ZodNullable<ZodType<Output, Def, Input>>

nullish

• nullish(): ZodOptional<ZodNullable<ZodType<Output, Def, Input>>>

• Returns ZodOptional<ZodNullable<ZodType<Output, Def, Input>>>

optional

• optional(): ZodOptional<ZodType<Output, Def, Input>>

• Returns ZodOptional<ZodType<Output, Def, Input>>

or

• or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodType<Output, Def, Input>, T]>

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

  Returns ZodUnion<[ZodType<Output, Def, Input>, T]>

parse

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

  Returns Output

parseAsync

• parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<Output>

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

  Returns Promise<Output>

pipe

• pipe<T extends ZodTypeAny>(target: T): ZodPipeline<ZodType<Output, Def, Input>, T>

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodType<Output, Def, Input>, T>

promise

• promise(): ZodPromise<ZodType<Output, Def, Input>>

• Returns ZodPromise<ZodType<Output, Def, Input>>

readonly

• readonly(): ZodReadonly<ZodType<Output, Def, Input>>

• Returns ZodReadonly<ZodType<Output, Def, Input>>

refine

• refine<RefinedOutput>(check: ((arg: Output) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

• Type Parameters

  • RefinedOutput

  Parameters

  • check: ((arg: Output) => arg is RefinedOutput)
    • • (arg: Output): arg is RefinedOutput

      • Parameters

        • arg: Output

        Returns arg is RefinedOutput

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

  Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

• refine(check: ((arg: Output) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>

• Parameters

  • check: ((arg: Output) => unknown)
    • • (arg: Output): unknown

      • Parameters

        • arg: Output

        Returns unknown

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

  Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

refinement

• refinement<RefinedOutput>(check: ((arg: Output) => arg is RefinedOutput), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

• Type Parameters

  • RefinedOutput

  Parameters

  • check: ((arg: Output) => arg is RefinedOutput)
    • • (arg: Output): arg is RefinedOutput

      • Parameters

        • arg: Output

        Returns arg is RefinedOutput

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

  Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

• refinement(check: ((arg: Output) => boolean), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>

• Parameters

  • check: ((arg: Output) => boolean)
    • • (arg: Output): boolean

      • Parameters

        • arg: Output

        Returns boolean

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

  Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

safeParse

• safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<Input, Output>

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

  Returns SafeParseReturnType<Input, Output>

safeParseAsync

• safeParseAsync(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Input, Output>>

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

  Returns Promise<SafeParseReturnType<Input, Output>>

superRefine

• superRefine<RefinedOutput>(refinement: ((arg: Output, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

• Type Parameters

  • RefinedOutput

  Parameters

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

      • Parameters

        • arg: Output
        • ctx: RefinementCtx

        Returns arg is RefinedOutput

  Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>

• superRefine(refinement: ((arg: Output, ctx: RefinementCtx) => void)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>

• Parameters

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

      • Parameters

        • arg: Output
        • ctx: RefinementCtx

        Returns void

  Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

• superRefine(refinement: ((arg: Output, ctx: RefinementCtx) => Promise<void>)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>

• Parameters

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

      • Parameters

        • arg: Output
        • ctx: RefinementCtx

        Returns Promise<void>

  Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

transform

• transform<NewOut>(transform: ((arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>)): ZodEffects<ZodType<Output, Def, Input>, NewOut, Input>

• Type Parameters

  • NewOut

  Parameters

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

      • Parameters

        • arg: Output
        • ctx: RefinementCtx

        Returns NewOut | Promise<NewOut>

  Returns ZodEffects<ZodType<Output, Def, Input>, NewOut, Input>