Class ZodOptional<T>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

spa

description

• get description(): string | undefined

  Returns string | undefined

_getOrReturnCtx

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

  Parameters

  • input: z.ParseInput
  • Optionalctx: z.ParseContext

  Returns z.ParseContext

_getType

• _getType(input: z.ParseInput): string

  Parameters

  • input: z.ParseInput

  Returns string

_parseAsync

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

  Parameters

  • input: z.ParseInput

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

_parseSync

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

  Parameters

  • input: z.ParseInput

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

_processInputParams

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

  Parameters

  • input: z.ParseInput

  Returns { ctx: z.ParseContext; status: z.ParseStatus }

_refinement

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

  Parameters

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

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

~validate

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

  Parameters

  • data: unknown

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

and

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

  Type Parameters

  • T extends z.ZodTypeAny

  Parameters

  • incoming: T

  Returns z.ZodIntersection<z.ZodOptional<T>, T>

array

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

  Returns z.ZodArray<z.ZodOptional<T>>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns z.ZodBranded<z.ZodOptional<T>, B>

catch

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

  Parameters

  • def: T["_output"] | undefined

  Returns z.ZodCatch<z.ZodOptional<T>>

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

  Parameters

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

  Returns z.ZodCatch<z.ZodOptional<T>>

default

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

  Parameters

  • def: z.util.noUndefined<T["_input"]>

  Returns z.ZodDefault<z.ZodOptional<T>>

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

  Parameters

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

  Returns z.ZodDefault<z.ZodOptional<T>>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

  Returns boolean

isOptional

• isOptional(): boolean

  Returns boolean

nullable

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

  Returns z.ZodNullable<z.ZodOptional<T>>

nullish

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

  Returns z.ZodOptional<z.ZodNullable<z.ZodOptional<T>>>

optional

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

  Returns z.ZodOptional<z.ZodOptional<T>>

or

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

  Type Parameters

  • T extends z.ZodTypeAny

  Parameters

  • option: T

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

parse

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

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

  Returns T["_output"] | undefined

parseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

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

pipe

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

  Type Parameters

  • T extends z.ZodTypeAny

  Parameters

  • target: T

  Returns z.ZodPipeline<z.ZodOptional<T>, T>

promise

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

  Returns z.ZodPromise<z.ZodOptional<T>>

readonly

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

  Returns z.ZodReadonly<z.ZodOptional<T>>

refine

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

  Type Parameters

  • RefinedOutput extends any

  Parameters

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

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

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

  Parameters

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

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

refinement

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

  Type Parameters

  • RefinedOutput extends any

  Parameters

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

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

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

  Parameters

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

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

safeParse

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

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

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

safeParseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: z.util.InexactPartial<z.ParseParams>

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

superRefine

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

  Type Parameters

  • RefinedOutput extends any

  Parameters

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

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

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

  Parameters

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

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

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

  Parameters

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

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

transform

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

  Type Parameters

  • NewOut

  Parameters

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

  Returns z.ZodEffects<z.ZodOptional<T>, NewOut>