Class ZodOptional<T>

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<T["_output"] | undefined>

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<T["_output"] | undefined>

_parseSync

• _parseSync(input: ParseInput): SyncParseReturnType<T["_output"] | undefined>

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<T["_output"] | undefined>

_processInputParams

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

  Parameters

  • input: ParseInput

  Returns { ctx: ParseContext; status: ParseStatus }

_refinement

• _refinement(
      refinement: (arg: T["_output"] | undefined, ctx: RefinementCtx) => any,
  ): ZodEffects<
      ZodOptional<T>,
      T["_output"] | undefined,
      T["_input"] | undefined,
  >

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, T["_output"] | undefined, T["_input"] | undefined>

and

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodOptional<T>, T>

array

• array(): ZodArray<ZodOptional<T>>

  Returns ZodArray<ZodOptional<T>>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodOptional<T>, B>

catch

• catch(def: T["_output"] | undefined): ZodCatch<ZodOptional<T>>

  Parameters

  • def: T["_output"] | undefined

  Returns ZodCatch<ZodOptional<T>>

• catch(
      def: (
          ctx: { error: ZodError; input: T["_input"] | undefined },
      ) => T["_output"] | undefined,
  ): ZodCatch<ZodOptional<T>>

  Parameters

  • def: (
        ctx: { error: ZodError; input: T["_input"] | undefined },
    ) => T["_output"] | undefined

  Returns ZodCatch<ZodOptional<T>>

default

• default(def: noUndefined<T["_input"]>): ZodDefault<ZodOptional<T>>

  Parameters

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

  Returns ZodDefault<ZodOptional<T>>

• default(def: () => noUndefined<T["_input"]>): ZodDefault<ZodOptional<T>>

  Parameters

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

  Returns ZodDefault<ZodOptional<T>>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

  Returns boolean

isOptional

• isOptional(): boolean

  Returns boolean

nullable

• nullable(): ZodNullable<ZodOptional<T>>

  Returns ZodNullable<ZodOptional<T>>

nullish

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

  Returns ZodOptional<ZodNullable<ZodOptional<T>>>

optional

• optional(): ZodOptional<ZodOptional<T>>

  Returns ZodOptional<ZodOptional<T>>

or

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

  Returns ZodUnion<[ZodOptional<T>, T]>

parse

• parse(data: unknown, params?: Partial<ParseParams>): T["_output"] | undefined

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns T["_output"] | undefined

parseAsync

• parseAsync(
      data: unknown,
      params?: Partial<ParseParams>,
  ): Promise<T["_output"] | undefined>

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<T["_output"] | undefined>

pipe

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodOptional<T>, T>

promise

• promise(): ZodPromise<ZodOptional<T>>

  Returns ZodPromise<ZodOptional<T>>

readonly

• readonly(): ZodReadonly<ZodOptional<T>>

  Returns ZodReadonly<ZodOptional<T>>

refine

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

  Type Parameters

  • RefinedOutput extends any

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, RefinedOutput, T["_input"] | undefined>

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

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, T["_output"] | undefined, T["_input"] | undefined>

refinement

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

  Type Parameters

  • RefinedOutput extends any

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, RefinedOutput, T["_input"] | undefined>

• refinement(
      check: (arg: T["_output"] | undefined) => boolean,
      refinementData:
          | IssueData
          | ((arg: T["_output"] | undefined, ctx: RefinementCtx) => IssueData),
  ): ZodEffects<
      ZodOptional<T>,
      T["_output"] | undefined,
      T["_input"] | undefined,
  >

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, T["_output"] | undefined, T["_input"] | undefined>

safeParse

• safeParse(
      data: unknown,
      params?: Partial<ParseParams>,
  ): SafeParseReturnType<T["_input"] | undefined, T["_output"] | undefined>

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns SafeParseReturnType<T["_input"] | undefined, T["_output"] | undefined>

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: Partial<ParseParams>,
  ): Promise<
      SafeParseReturnType<T["_input"] | undefined, T["_output"] | undefined>,
  >

  Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<SafeParseReturnType<T["_input"] | undefined, T["_output"] | undefined>>

superRefine

• superRefine<RefinedOutput extends any>(
      refinement: (
          arg: T["_output"] | undefined,
          ctx: RefinementCtx,
      ) => arg is RefinedOutput,
  ): ZodEffects<ZodOptional<T>, RefinedOutput, T["_input"] | undefined>

  Type Parameters

  • RefinedOutput extends any

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, RefinedOutput, T["_input"] | undefined>

• superRefine(
      refinement: (arg: T["_output"] | undefined, ctx: RefinementCtx) => void,
  ): ZodEffects<
      ZodOptional<T>,
      T["_output"] | undefined,
      T["_input"] | undefined,
  >

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, T["_output"] | undefined, T["_input"] | undefined>

• superRefine(
      refinement: (
          arg: T["_output"] | undefined,
          ctx: RefinementCtx,
      ) => Promise<void>,
  ): ZodEffects<
      ZodOptional<T>,
      T["_output"] | undefined,
      T["_input"] | undefined,
  >

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, T["_output"] | undefined, T["_input"] | undefined>

transform

• transform<NewOut>(
      transform: (
          arg: T["_output"] | undefined,
          ctx: RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): ZodEffects<ZodOptional<T>, NewOut>

  Type Parameters

  • NewOut

  Parameters

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

  Returns ZodEffects<ZodOptional<T>, NewOut>