Class ZodUndefined

constructor

• new ZodUndefined(def: ZodUndefinedDef): ZodUndefined

  Parameters

  • def: ZodUndefinedDef

  Returns ZodUndefined

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

Optionalparams

spa

Staticcreate

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

_parse

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

  Parameters

  • input: ParseInput

  Returns ParseReturnType<undefined>

_parseAsync

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

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<undefined>

_parseSync

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

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<undefined>

_processInputParams

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

  Parameters

  • input: ParseInput

  Returns { ctx: ParseContext; status: ParseStatus }

_refinement

• _refinement(
      refinement: (arg: undefined, ctx: RefinementCtx) => any,
  ): ZodEffects<ZodUndefined, undefined, undefined>

  Parameters

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

  Returns ZodEffects<ZodUndefined, undefined, undefined>

~validate

• "~validate"(data: unknown): Result<undefined> | Promise<Result<undefined>>

  Parameters

  • data: unknown

  Returns Result<undefined> | Promise<Result<undefined>>

and

• and<T extends ZodTypeAny>(incoming: T): ZodIntersection<ZodUndefined, T>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodUndefined, T>

array

• array(): ZodArray<ZodUndefined>

  Returns ZodArray<ZodUndefined>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodUndefined, B>

catch

• catch(def: undefined): ZodCatch<ZodUndefined>

  Parameters

  • def: undefined

  Returns ZodCatch<ZodUndefined>

• catch(
      def: (ctx: { error: ZodError; input: undefined }) => undefined,
  ): ZodCatch<ZodUndefined>

  Parameters

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

  Returns ZodCatch<ZodUndefined>

default

• default(def: never): ZodDefault<ZodUndefined>

  Parameters

  • def: never

  Returns ZodDefault<ZodUndefined>

• default(def: () => never): ZodDefault<ZodUndefined>

  Parameters

  • def: () => never

  Returns ZodDefault<ZodUndefined>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

  Returns boolean

isOptional

• isOptional(): boolean

  Returns boolean

nullable

• nullable(): ZodNullable<ZodUndefined>

  Returns ZodNullable<ZodUndefined>

nullish

• nullish(): ZodOptional<ZodNullable<ZodUndefined>>

  Returns ZodOptional<ZodNullable<ZodUndefined>>

optional

• optional(): ZodOptional<ZodUndefined>

  Returns ZodOptional<ZodUndefined>

or

• or<T extends ZodTypeAny>(option: T): ZodUnion<[ZodUndefined, T]>

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

  Returns ZodUnion<[ZodUndefined, T]>

parse

• parse(data: unknown, params?: InexactPartial<ParseParams>): undefined

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns undefined

parseAsync

• parseAsync(
      data: unknown,
      params?: InexactPartial<ParseParams>,
  ): Promise<undefined>

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<undefined>

pipe

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodUndefined, T>

promise

• promise(): ZodPromise<ZodUndefined>

  Returns ZodPromise<ZodUndefined>

readonly

• readonly(): ZodReadonly<ZodUndefined>

  Returns ZodReadonly<ZodUndefined>

refine

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

  Type Parameters

  • RefinedOutput extends undefined

  Parameters

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

  Returns ZodEffects<ZodUndefined, RefinedOutput, undefined>

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

  Parameters

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

  Returns ZodEffects<ZodUndefined, undefined, undefined>

refinement

• refinement<RefinedOutput extends undefined>(
      check: (arg: undefined) => arg is RefinedOutput,
      refinementData:
          | IssueData
          | ((arg: undefined, ctx: RefinementCtx) => IssueData),
  ): ZodEffects<ZodUndefined, RefinedOutput, undefined>

  Type Parameters

  • RefinedOutput extends undefined

  Parameters

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

  Returns ZodEffects<ZodUndefined, RefinedOutput, undefined>

• refinement(
      check: (arg: undefined) => boolean,
      refinementData:
          | IssueData
          | ((arg: undefined, ctx: RefinementCtx) => IssueData),
  ): ZodEffects<ZodUndefined, undefined, undefined>

  Parameters

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

  Returns ZodEffects<ZodUndefined, undefined, undefined>

safeParse

• safeParse(
      data: unknown,
      params?: InexactPartial<ParseParams>,
  ): SafeParseReturnType<undefined, undefined>

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns SafeParseReturnType<undefined, undefined>

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: InexactPartial<ParseParams>,
  ): Promise<SafeParseReturnType<undefined, undefined>>

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<SafeParseReturnType<undefined, undefined>>

superRefine

• superRefine<RefinedOutput extends undefined>(
      refinement: (arg: undefined, ctx: RefinementCtx) => arg is RefinedOutput,
  ): ZodEffects<ZodUndefined, RefinedOutput, undefined>

  Type Parameters

  • RefinedOutput extends undefined

  Parameters

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

  Returns ZodEffects<ZodUndefined, RefinedOutput, undefined>

• superRefine(
      refinement: (arg: undefined, ctx: RefinementCtx) => void,
  ): ZodEffects<ZodUndefined, undefined, undefined>

  Parameters

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

  Returns ZodEffects<ZodUndefined, undefined, undefined>

• superRefine(
      refinement: (arg: undefined, ctx: RefinementCtx) => Promise<void>,
  ): ZodEffects<ZodUndefined, undefined, undefined>

  Parameters

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

  Returns ZodEffects<ZodUndefined, undefined, undefined>

transform

• transform<NewOut>(
      transform: (
          arg: undefined,
          ctx: RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): ZodEffects<ZodUndefined, NewOut>

  Type Parameters

  • NewOut

  Parameters

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

  Returns ZodEffects<ZodUndefined, NewOut>