Class ZodDiscriminatedUnion<Discriminator, Options>

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
  • Optionalctx: ParseContext

  Returns ParseContext

_getType

• _getType(input: ParseInput): string

• Parameters

  • input: ParseInput

  Returns string

_parseAsync

• _parseAsync(input: ParseInput): AsyncParseReturnType<output<Options[number]>>

• Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<output<Options[number]>>

_parseSync

• _parseSync(input: ParseInput): SyncParseReturnType<output<Options[number]>>

• Parameters

  • input: ParseInput

  Returns SyncParseReturnType<output<Options[number]>>

_processInputParams

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

• Parameters

  • input: ParseInput

  Returns { ctx: ParseContext; status: ParseStatus }

_refinement

• _refinement(
      refinement: (arg: output<Options[number]>, ctx: RefinementCtx) => any,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

• Parameters

  • refinement: (arg: output<Options[number]>, ctx: RefinementCtx) => any

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

and

• and<T extends ZodType<any, any, any, T>>(
      incoming: T,
  ): ZodIntersection<ZodDiscriminatedUnion<Discriminator, Options>, T>

• Type Parameters

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

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodDiscriminatedUnion<Discriminator, Options>, T>

array

• array(): ZodArray<ZodDiscriminatedUnion<Discriminator, Options>, "many">

• Returns ZodArray<ZodDiscriminatedUnion<Discriminator, Options>, "many">

brand

• brand<B extends string | number | symbol>(
      brand?: B,
  ): ZodBranded<ZodDiscriminatedUnion<Discriminator, Options>, B>

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodDiscriminatedUnion<Discriminator, Options>, B>

catch

• catch(
      def: output<Options[number]>,
  ): ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>

• Parameters

  • def: output<Options[number]>

  Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>

• catch(
      def: (
          ctx: { error: ZodError<any>; input: input<Options[number]> },
      ) => output<Options[number]>,
  ): ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>

• Parameters

  • def: (
        ctx: { error: ZodError<any>; input: input<Options[number]> },
    ) => output<Options[number]>

  Returns ZodCatch<ZodDiscriminatedUnion<Discriminator, Options>>

default

• default(
      def: noUndefined<input<Options[number]>>,
  ): ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>

• Parameters

  • def: noUndefined<input<Options[number]>>

  Returns ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>

• default(
      def: () => noUndefined<input<Options[number]>>,
  ): ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>

• Parameters

  • def: () => noUndefined<input<Options[number]>>

  Returns ZodDefault<ZodDiscriminatedUnion<Discriminator, Options>>

describe

• describe(description: string): this

• Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

• Returns boolean

isOptional

• isOptional(): boolean

• Returns boolean

nullable

• nullable(): ZodNullable<ZodDiscriminatedUnion<Discriminator, Options>>

• Returns ZodNullable<ZodDiscriminatedUnion<Discriminator, Options>>

nullish

• nullish(): ZodOptional<
      ZodNullable<ZodDiscriminatedUnion<Discriminator, Options>>,
  >

• Returns ZodOptional<ZodNullable<ZodDiscriminatedUnion<Discriminator, Options>>>

optional

• optional(): ZodOptional<ZodDiscriminatedUnion<Discriminator, Options>>

• Returns ZodOptional<ZodDiscriminatedUnion<Discriminator, Options>>

or

• or<T extends ZodType<any, any, any, T>>(
      option: T,
  ): ZodUnion<[ZodDiscriminatedUnion<Discriminator, Options>, T]>

• Type Parameters

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

  Parameters

  • option: T

  Returns ZodUnion<[ZodDiscriminatedUnion<Discriminator, Options>, T]>

parse

• parse(data: unknown, params?: Partial<ParseParams>): output<Options[number]>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns output<Options[number]>

parseAsync

• parseAsync(
      data: unknown,
      params?: Partial<ParseParams>,
  ): Promise<output<Options[number]>>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<output<Options[number]>>

pipe

• pipe<T extends ZodType<any, any, any, T>>(
      target: T,
  ): ZodPipeline<ZodDiscriminatedUnion<Discriminator, Options>, T>

• Type Parameters

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

  Parameters

  • target: T

  Returns ZodPipeline<ZodDiscriminatedUnion<Discriminator, Options>, T>

promise

• promise(): ZodPromise<ZodDiscriminatedUnion<Discriminator, Options>>

• Returns ZodPromise<ZodDiscriminatedUnion<Discriminator, Options>>

readonly

• readonly(): ZodReadonly<ZodDiscriminatedUnion<Discriminator, Options>>

• Returns ZodReadonly<ZodDiscriminatedUnion<Discriminator, Options>>

refine

• refine<
      RefinedOutput extends
          {
              [k in string
              | number]: addQuestionMarks<
                  baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
                  any,
              >[k]
          },
  >(
      check: (arg: output<Options[number]>) => arg is RefinedOutput,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | (arg: output<Options[number]>) => Partial<Omit<ZodCustomIssue, "code">>,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      RefinedOutput,
      input<Options[number]>,
  >

• Type Parameters

  • RefinedOutput extends {
        [k in string | number]: addQuestionMarks<
            baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
            any,
        >[k]
    }

  Parameters

  • check: (arg: output<Options[number]>) => arg is RefinedOutput
  • Optionalmessage:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | (arg: output<Options[number]>) => Partial<Omit<ZodCustomIssue, "code">>

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      RefinedOutput,
      input<Options[number]>,
  >

• refine(
      check: (arg: output<Options[number]>) => unknown,
      message?:
          | string
          | Partial<Omit<ZodCustomIssue, "code">>
          | (arg: output<Options[number]>) => Partial<Omit<ZodCustomIssue, "code">>,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

• Parameters

  • check: (arg: output<Options[number]>) => unknown
  • Optionalmessage:
        | string
        | Partial<Omit<ZodCustomIssue, "code">>
        | (arg: output<Options[number]>) => Partial<Omit<ZodCustomIssue, "code">>

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

refinement

• refinement<
      RefinedOutput extends
          {
              [k in string
              | number]: addQuestionMarks<
                  baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
                  any,
              >[k]
          },
  >(
      check: (arg: output<Options[number]>) => arg is RefinedOutput,
      refinementData:
          | IssueData
          | (arg: output<Options[number]>, ctx: RefinementCtx) => IssueData,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      RefinedOutput,
      input<Options[number]>,
  >

• Type Parameters

  • RefinedOutput extends {
        [k in string | number]: addQuestionMarks<
            baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
            any,
        >[k]
    }

  Parameters

  • check: (arg: output<Options[number]>) => arg is RefinedOutput
  • refinementData: IssueData | (arg: output<Options[number]>, ctx: RefinementCtx) => IssueData

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      RefinedOutput,
      input<Options[number]>,
  >

• refinement(
      check: (arg: output<Options[number]>) => boolean,
      refinementData:
          | IssueData
          | (arg: output<Options[number]>, ctx: RefinementCtx) => IssueData,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

• Parameters

  • check: (arg: output<Options[number]>) => boolean
  • refinementData: IssueData | (arg: output<Options[number]>, ctx: RefinementCtx) => IssueData

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

safeParse

• safeParse(
      data: unknown,
      params?: Partial<ParseParams>,
  ): SafeParseReturnType<input<Options[number]>, output<Options[number]>>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns SafeParseReturnType<input<Options[number]>, output<Options[number]>>

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: Partial<ParseParams>,
  ): Promise<
      SafeParseReturnType<input<Options[number]>, output<Options[number]>>,
  >

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<SafeParseReturnType<input<Options[number]>, output<Options[number]>>>

superRefine

• superRefine<
      RefinedOutput extends
          {
              [k in string
              | number]: addQuestionMarks<
                  baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
                  any,
              >[k]
          },
  >(
      refinement: (
          arg: output<Options[number]>,
          ctx: RefinementCtx,
      ) => arg is RefinedOutput,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      RefinedOutput,
      input<Options[number]>,
  >

• Type Parameters

  • RefinedOutput extends {
        [k in string | number]: addQuestionMarks<
            baseObjectOutputType<{ [key in string]: ZodTypeAny } & ZodRawShape>,
            any,
        >[k]
    }

  Parameters

  • refinement: (arg: output<Options[number]>, ctx: RefinementCtx) => arg is RefinedOutput

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      RefinedOutput,
      input<Options[number]>,
  >

• superRefine(
      refinement: (arg: output<Options[number]>, ctx: RefinementCtx) => void,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

• Parameters

  • refinement: (arg: output<Options[number]>, ctx: RefinementCtx) => void

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

• superRefine(
      refinement: (
          arg: output<Options[number]>,
          ctx: RefinementCtx,
      ) => Promise<void>,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

• Parameters

  • refinement: (arg: output<Options[number]>, ctx: RefinementCtx) => Promise<void>

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      output<Options[number]>,
      input<Options[number]>,
  >

transform

• transform<NewOut>(
      transform: (
          arg: output<Options[number]>,
          ctx: RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      NewOut,
      input<Options[number]>,
  >

• Type Parameters

  • NewOut

  Parameters

  • transform: (arg: output<Options[number]>, ctx: RefinementCtx) => NewOut | Promise<NewOut>

  Returns ZodEffects<
      ZodDiscriminatedUnion<Discriminator, Options>,
      NewOut,
      input<Options[number]>,
  >