Class ZodEffects<T, Output, Input>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

description

• get description(): undefined | string

• Returns undefined | string

_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<Output>

• Parameters

  • input: z.ParseInput

  Returns z.AsyncParseReturnType<Output>

_parseSync

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

• Parameters

  • input: z.ParseInput

  Returns z.SyncParseReturnType<Output>

_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: Output, ctx: z.RefinementCtx) => any,
  ): z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

• Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

and

• and<T extends z.ZodType<any, any, any, T>>(
      incoming: T,
  ): z.ZodIntersection<z.ZodEffects<T, Output, Input>, T>

• Type Parameters

  • T extends z.ZodType<any, any, any, T>

  Parameters

  • incoming: T

  Returns z.ZodIntersection<z.ZodEffects<T, Output, Input>, T>

array

• array(): z.ZodArray<z.ZodEffects<T, Output, Input>, "many">

• Returns z.ZodArray<z.ZodEffects<T, Output, Input>, "many">

brand

• brand<B extends string | number | symbol>(
      brand?: B,
  ): z.ZodBranded<z.ZodEffects<T, Output, Input>, B>

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns z.ZodBranded<z.ZodEffects<T, Output, Input>, B>

catch

• catch(def: Output): z.ZodCatch<z.ZodEffects<T, Output, Input>>

• Parameters

  • def: Output

  Returns z.ZodCatch<z.ZodEffects<T, Output, Input>>

• catch(
      def: (ctx: { error: z.ZodError<any>; input: Input }) => Output,
  ): z.ZodCatch<z.ZodEffects<T, Output, Input>>

• Parameters

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

  Returns z.ZodCatch<z.ZodEffects<T, Output, Input>>

default

• default(
      def: z.util.noUndefined<Input>,
  ): z.ZodDefault<z.ZodEffects<T, Output, Input>>

• Parameters

  • def: z.util.noUndefined<Input>

  Returns z.ZodDefault<z.ZodEffects<T, Output, Input>>

• default(
      def: () => z.util.noUndefined<Input>,
  ): z.ZodDefault<z.ZodEffects<T, Output, Input>>

• Parameters

  • def: () => z.util.noUndefined<Input>

  Returns z.ZodDefault<z.ZodEffects<T, Output, Input>>

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.ZodEffects<T, Output, Input>>

• Returns z.ZodNullable<z.ZodEffects<T, Output, Input>>

nullish

• nullish(): z.ZodOptional<z.ZodNullable<z.ZodEffects<T, Output, Input>>>

• Returns z.ZodOptional<z.ZodNullable<z.ZodEffects<T, Output, Input>>>

optional

• optional(): z.ZodOptional<z.ZodEffects<T, Output, Input>>

• Returns z.ZodOptional<z.ZodEffects<T, Output, Input>>

or

• or<T extends z.ZodType<any, any, any, T>>(
      option: T,
  ): z.ZodUnion<[z.ZodEffects<T, Output, Input>, T]>

• Type Parameters

  • T extends z.ZodType<any, any, any, T>

  Parameters

  • option: T

  Returns z.ZodUnion<[z.ZodEffects<T, Output, Input>, T]>

parse

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

• Parameters

  • data: unknown
  • Optionalparams: Partial<z.ParseParams>

  Returns Output

parseAsync

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

• Parameters

  • data: unknown
  • Optionalparams: Partial<z.ParseParams>

  Returns Promise<Output>

pipe

• pipe<T extends z.ZodType<any, any, any, T>>(
      target: T,
  ): z.ZodPipeline<z.ZodEffects<T, Output, Input>, T>

• Type Parameters

  • T extends z.ZodType<any, any, any, T>

  Parameters

  • target: T

  Returns z.ZodPipeline<z.ZodEffects<T, Output, Input>, T>

promise

• promise(): z.ZodPromise<z.ZodEffects<T, Output, Input>>

• Returns z.ZodPromise<z.ZodEffects<T, Output, Input>>

readonly

• readonly(): z.ZodReadonly<z.ZodEffects<T, Output, Input>>

• Returns z.ZodReadonly<z.ZodEffects<T, Output, Input>>

refine

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

• Type Parameters

  • RefinedOutput

  Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, RefinedOutput, Input>

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

• Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

refinement

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

• Type Parameters

  • RefinedOutput

  Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, RefinedOutput, Input>

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

• Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

safeParse

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

• Parameters

  • data: unknown
  • Optionalparams: Partial<z.ParseParams>

  Returns z.SafeParseReturnType<Input, Output>

safeParseAsync

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

• Parameters

  • data: unknown
  • Optionalparams: Partial<z.ParseParams>

  Returns Promise<z.SafeParseReturnType<Input, Output>>

superRefine

• superRefine<RefinedOutput>(
      refinement: (arg: Output, ctx: z.RefinementCtx) => arg is RefinedOutput,
  ): z.ZodEffects<z.ZodEffects<T, Output, Input>, RefinedOutput, Input>

• Type Parameters

  • RefinedOutput

  Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, RefinedOutput, Input>

• superRefine(
      refinement: (arg: Output, ctx: z.RefinementCtx) => void,
  ): z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

• Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

• superRefine(
      refinement: (arg: Output, ctx: z.RefinementCtx) => Promise<void>,
  ): z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

• Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, Output, Input>

transform

• transform<NewOut>(
      transform: (
          arg: Output,
          ctx: z.RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): z.ZodEffects<z.ZodEffects<T, Output, Input>, NewOut, Input>

• Type Parameters

  • NewOut

  Parameters

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

  Returns z.ZodEffects<z.ZodEffects<T, Output, Input>, NewOut, Input>