Class ZodOptional<T>

constructor

• new ZodOptional<T>(def): ZodOptional<T>

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • def: ZodOptionalDef<T>

  Returns ZodOptional<T>

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

description

• get description(): undefined | string

• Returns undefined | string

_getOrReturnCtx

• _getOrReturnCtx(input, ctx?): ParseContext

• Parameters

  • input: ParseInput
  • Optional ctx: ParseContext

  Returns ParseContext

_getType

• _getType(input): string

• Parameters

  • input: ParseInput

  Returns string

_parseAsync

• _parseAsync(input): AsyncParseReturnType<undefined | T["_output"]>

• Parameters

  • input: ParseInput

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

_parseSync

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

• Parameters

  • input: ParseInput

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

_processInputParams

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

• Parameters

  • input: ParseInput

  Returns {
      ctx: ParseContext;
      status: ParseStatus;
  }

  • ctx: ParseContext

  • status: ParseStatus

_refinement

• _refinement(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

• Parameters

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

      • Parameters

        • arg: undefined | T["_output"]
        • ctx: RefinementCtx

        Returns any

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

and

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

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodOptional<T>, T>

array

• array(): ZodArray<ZodOptional<T>, "many">

• Returns ZodArray<ZodOptional<T>, "many">

brand

• brand<B>(brand?): ZodBranded<ZodOptional<T>, B>

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optional brand: B

  Returns ZodBranded<ZodOptional<T>, B>

catch

• catch(def): ZodCatch<ZodOptional<T>>

• Parameters

  • def: undefined | T["_output"]

  Returns ZodCatch<ZodOptional<T>>

• catch(def): ZodCatch<ZodOptional<T>>

• Parameters

  • def: ((ctx) => undefined | T["_output"])
    • • (ctx): undefined | T["_output"]

      • Parameters

        • ctx: {
              error: ZodError<any>;
              input: undefined | T["_input"];
          }

          • error: ZodError<any>

          • input: undefined | T["_input"]

        Returns undefined | T["_output"]

  Returns ZodCatch<ZodOptional<T>>

default

• default(def): ZodDefault<ZodOptional<T>>

• Parameters

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

  Returns ZodDefault<ZodOptional<T>>

• default(def): ZodDefault<ZodOptional<T>>

• Parameters

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

      • Returns noUndefined<T["_input"]>

  Returns ZodDefault<ZodOptional<T>>

describe

• describe(description): 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>(option): ZodUnion<[ZodOptional<T>, T]>

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

parse

• parse(data, params?): undefined | T["_output"]

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

  Returns undefined | T["_output"]

parseAsync

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

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

pipe

• pipe<T>(target): 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>(check, message?): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

• Type Parameters

  • RefinedOutput extends any

  Parameters

  • check: ((arg) => arg is RefinedOutput)
    • • (arg): arg is RefinedOutput

      • Parameters

        • arg: undefined | T["_output"]

        Returns arg is RefinedOutput

  • Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)

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

• refine(check, message?): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

• Parameters

  • check: ((arg) => unknown)
    • • (arg): unknown

      • Parameters

        • arg: undefined | T["_output"]

        Returns unknown

  • Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg) => Partial<Omit<ZodCustomIssue, "code">>)

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

refinement

• refinement<RefinedOutput>(check, refinementData): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

• Type Parameters

  • RefinedOutput extends any

  Parameters

  • check: ((arg) => arg is RefinedOutput)
    • • (arg): arg is RefinedOutput

      • Parameters

        • arg: undefined | T["_output"]

        Returns arg is RefinedOutput

  • refinementData: IssueData | ((arg, ctx) => IssueData)

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

• refinement(check, refinementData): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

• Parameters

  • check: ((arg) => boolean)
    • • (arg): boolean

      • Parameters

        • arg: undefined | T["_output"]

        Returns boolean

  • refinementData: IssueData | ((arg, ctx) => IssueData)

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

safeParse

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

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

safeParseAsync

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

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

superRefine

• superRefine<RefinedOutput>(refinement): ZodEffects<ZodOptional<T>, RefinedOutput, undefined | T["_input"]>

• Type Parameters

  • RefinedOutput extends any

  Parameters

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

      • Parameters

        • arg: undefined | T["_output"]
        • ctx: RefinementCtx

        Returns arg is RefinedOutput

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

• superRefine(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

• Parameters

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

      • Parameters

        • arg: undefined | T["_output"]
        • ctx: RefinementCtx

        Returns void

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

• superRefine(refinement): ZodEffects<ZodOptional<T>, undefined | T["_output"], undefined | T["_input"]>

• Parameters

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

      • Parameters

        • arg: undefined | T["_output"]
        • ctx: RefinementCtx

        Returns Promise<void>

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

transform

• transform<NewOut>(transform): ZodEffects<ZodOptional<T>, NewOut, undefined | T["_input"]>

• Type Parameters

  • NewOut

  Parameters

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

      • Parameters

        • arg: undefined | T["_output"]
        • ctx: RefinementCtx

        Returns NewOut | Promise<NewOut>

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