Class ZodEffects<T, Output, Input>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

description

• get description(): string | undefined

  Returns string | undefined

_getOrReturnCtx

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

  Parameters

  • input: ParseInput
  • Optionalctx: ParseContext

  Returns ParseContext

_getType

• _getType(input: ParseInput): string

  Parameters

  • input: ParseInput

  Returns string

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

_refinement

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

  Parameters

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

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

and

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

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

array

• array(): ZodArray<ZodEffects<T, Output, Input>>

  Returns ZodArray<ZodEffects<T, Output, Input>>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

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

catch

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

  Parameters

  • def: Output

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

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

  Parameters

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

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

default

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

  Parameters

  • def: noUndefined<Input>

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

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

  Parameters

  • def: () => noUndefined<Input>

  Returns ZodDefault<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(): ZodNullable<ZodEffects<T, Output, Input>>

  Returns ZodNullable<ZodEffects<T, Output, Input>>

nullish

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

  Returns ZodOptional<ZodNullable<ZodEffects<T, Output, Input>>>

optional

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

  Returns ZodOptional<ZodEffects<T, Output, Input>>

or

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

parse

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

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Output

parseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<Output>

pipe

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

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

promise

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

  Returns ZodPromise<ZodEffects<T, Output, Input>>

readonly

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

  Returns ZodReadonly<ZodEffects<T, Output, Input>>

refine

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

  Type Parameters

  • RefinedOutput

  Parameters

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

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

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

  Parameters

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

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

refinement

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

  Type Parameters

  • RefinedOutput

  Parameters

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

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

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

  Parameters

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

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

safeParse

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

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns SafeParseReturnType<Input, Output>

safeParseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<SafeParseReturnType<Input, Output>>

superRefine

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

  Type Parameters

  • RefinedOutput

  Parameters

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

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

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

  Parameters

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

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

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

  Parameters

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

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

transform

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

  Type Parameters

  • NewOut

  Parameters

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

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