Class ZodPipeline<A, B>

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

description

• get description(): undefined | string

  Returns undefined | string

_getType

• _getType(input: ParseInput): string

  Parameters

  • input: ParseInput

  Returns string

_getOrReturnCtx

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

  Parameters

  • input: ParseInput
  • Optionalctx: ParseContext

  Returns ParseContext

_processInputParams

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

  Parameters

  • input: ParseInput

  Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

• _parseSync(input: ParseInput): SyncParseReturnType<B["_output"]>

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<B["_output"]>

_parseAsync

• _parseAsync(input: ParseInput): AsyncParseReturnType<B["_output"]>

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<B["_output"]>

parse

• parse(data: unknown, params?: InexactPartial<ParseParams>): B["_output"]

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns B["_output"]

safeParse

• safeParse(
      data: unknown,
      params?: InexactPartial<ParseParams>,
  ): SafeParseReturnType<A["_input"], B["_output"]>

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns SafeParseReturnType<A["_input"], B["_output"]>

~validate

• "~validate"(data: unknown): Result<B["_output"]> | Promise<Result<B["_output"]>>

  Parameters

  • data: unknown

  Returns Result<B["_output"]> | Promise<Result<B["_output"]>>

parseAsync

• parseAsync(
      data: unknown,
      params?: InexactPartial<ParseParams>,
  ): Promise<B["_output"]>

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<B["_output"]>

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: InexactPartial<ParseParams>,
  ): Promise<SafeParseReturnType<A["_input"], B["_output"]>>

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<SafeParseReturnType<A["_input"], B["_output"]>>

refine

• refine<RefinedOutput extends any>(
      check: (arg: B["_output"]) => arg is RefinedOutput,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | ((arg: B["_output"]) => CustomErrorParams),
  ): ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

  Type Parameters

  • RefinedOutput extends any

  Parameters

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

  Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

• refine(
      check: (arg: B["_output"]) => unknown,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | ((arg: B["_output"]) => CustomErrorParams),
  ): ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

  Parameters

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

  Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

refinement

• refinement<RefinedOutput extends any>(
      check: (arg: B["_output"]) => arg is RefinedOutput,
      refinementData:
          | IssueData
          | ((arg: B["_output"], ctx: RefinementCtx) => IssueData),
  ): ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

  Type Parameters

  • RefinedOutput extends any

  Parameters

  • check: (arg: B["_output"]) => arg is RefinedOutput
  • refinementData: IssueData | ((arg: B["_output"], ctx: RefinementCtx) => IssueData)

  Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

• refinement(
      check: (arg: B["_output"]) => boolean,
      refinementData:
          | IssueData
          | ((arg: B["_output"], ctx: RefinementCtx) => IssueData),
  ): ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

  Parameters

  • check: (arg: B["_output"]) => boolean
  • refinementData: IssueData | ((arg: B["_output"], ctx: RefinementCtx) => IssueData)

  Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

_refinement

• _refinement(
      refinement: (arg: B["_output"], ctx: RefinementCtx) => any,
  ): ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

  Parameters

  • refinement: (arg: B["_output"], ctx: RefinementCtx) => any

  Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

superRefine

• superRefine<RefinedOutput extends any>(
      refinement: (
          arg: B["_output"],
          ctx: RefinementCtx,
      ) => arg is RefinedOutput,
  ): ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

  Type Parameters

  • RefinedOutput extends any

  Parameters

  • refinement: (arg: B["_output"], ctx: RefinementCtx) => arg is RefinedOutput

  Returns ZodEffects<ZodPipeline<A, B>, RefinedOutput, A["_input"]>

• superRefine(
      refinement: (arg: B["_output"], ctx: RefinementCtx) => void,
  ): ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

  Parameters

  • refinement: (arg: B["_output"], ctx: RefinementCtx) => void

  Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

• superRefine(
      refinement: (arg: B["_output"], ctx: RefinementCtx) => Promise<void>,
  ): ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

  Parameters

  • refinement: (arg: B["_output"], ctx: RefinementCtx) => Promise<void>

  Returns ZodEffects<ZodPipeline<A, B>, B["_output"], A["_input"]>

optional

• optional(): ZodOptional<ZodPipeline<A, B>>

  Returns ZodOptional<ZodPipeline<A, B>>

nullable

• nullable(): ZodNullable<ZodPipeline<A, B>>

  Returns ZodNullable<ZodPipeline<A, B>>

nullish

• nullish(): ZodOptional<ZodNullable<ZodPipeline<A, B>>>

  Returns ZodOptional<ZodNullable<ZodPipeline<A, B>>>

array

• array(): ZodArray<ZodPipeline<A, B>>

  Returns ZodArray<ZodPipeline<A, B>>

promise

• promise(): ZodPromise<ZodPipeline<A, B>>

  Returns ZodPromise<ZodPipeline<A, B>>

or

• or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodPipeline<A, B>, T]>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

  Returns ZodUnion<[ZodPipeline<A, B>, T]>

and

• and<T extends ZodTypeAny>(incoming: T): ZodIntersection<ZodPipeline<A, B>, T>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodPipeline<A, B>, T>

transform

• transform<NewOut>(
      transform: (
          arg: B["_output"],
          ctx: RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): ZodEffects<ZodPipeline<A, B>, NewOut>

  Type Parameters

  • NewOut

  Parameters

  • transform: (arg: B["_output"], ctx: RefinementCtx) => NewOut | Promise<NewOut>

  Returns ZodEffects<ZodPipeline<A, B>, NewOut>

default

• default(def: noUndefined<A["_input"]>): ZodDefault<ZodPipeline<A, B>>

  Parameters

  • def: noUndefined<A["_input"]>

  Returns ZodDefault<ZodPipeline<A, B>>

• default(def: () => noUndefined<A["_input"]>): ZodDefault<ZodPipeline<A, B>>

  Parameters

  • def: () => noUndefined<A["_input"]>

  Returns ZodDefault<ZodPipeline<A, B>>

brand

• brand<B extends string | number | symbol>(
      brand?: B,
  ): ZodBranded<ZodPipeline<A, B>, B>

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodPipeline<A, B>, B>

catch

• catch(def: B["_output"]): ZodCatch<ZodPipeline<A, B>>

  Parameters

  • def: B["_output"]

  Returns ZodCatch<ZodPipeline<A, B>>

• catch(
      def: (ctx: { error: ZodError; input: A["_input"] }) => B["_output"],
  ): ZodCatch<ZodPipeline<A, B>>

  Parameters

  • def: (ctx: { error: ZodError; input: A["_input"] }) => B["_output"]

  Returns ZodCatch<ZodPipeline<A, B>>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

pipe

• pipe<T extends ZodTypeAny>(target: T): ZodPipeline<ZodPipeline<A, B>, T>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodPipeline<A, B>, T>

readonly

• readonly(): ZodReadonly<ZodPipeline<A, B>>

  Returns ZodReadonly<ZodPipeline<A, B>>

isOptional

• isOptional(): boolean

  Returns boolean

isNullable

• isNullable(): boolean

  Returns boolean