Class ZodNull

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<null>

• Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<null>

_parseSync

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

• Parameters

  • input: ParseInput

  Returns SyncParseReturnType<null>

_processInputParams

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

• Parameters

  • input: ParseInput

  Returns { ctx: ParseContext; status: ParseStatus }

_refinement

• _refinement(
      refinement: (arg: null, ctx: RefinementCtx) => any,
  ): ZodEffects<ZodNull, null, null>

• Parameters

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

  Returns ZodEffects<ZodNull, null, null>

and

• and<T extends ZodType<any, any, any, T>>(
      incoming: T,
  ): ZodIntersection<ZodNull, T>

• Type Parameters

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

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodNull, T>

array

• array(): ZodArray<ZodNull, "many">

• Returns ZodArray<ZodNull, "many">

brand

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

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodNull, B>

catch

• catch(def: null): ZodCatch<ZodNull>

• Parameters

  • def: null

  Returns ZodCatch<ZodNull>

• catch(
      def: (ctx: { error: ZodError<any>; input: null }) => null,
  ): ZodCatch<ZodNull>

• Parameters

  • def: (ctx: { error: ZodError<any>; input: null }) => null

  Returns ZodCatch<ZodNull>

default

• default(def: null): ZodDefault<ZodNull>

• Parameters

  • def: null

  Returns ZodDefault<ZodNull>

• default(def: () => null): ZodDefault<ZodNull>

• Parameters

  • def: () => null

  Returns ZodDefault<ZodNull>

describe

• describe(description: string): this

• Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

• Returns boolean

isOptional

• isOptional(): boolean

• Returns boolean

nullable

• nullable(): ZodNullable<ZodNull>

• Returns ZodNullable<ZodNull>

nullish

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

• Returns ZodOptional<ZodNullable<ZodNull>>

optional

• optional(): ZodOptional<ZodNull>

• Returns ZodOptional<ZodNull>

or

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

• Type Parameters

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

  Parameters

  • option: T

  Returns ZodUnion<[ZodNull, T]>

parse

• parse(data: unknown, params?: Partial<ParseParams>): null

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns null

parseAsync

• parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<null>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<null>

pipe

• pipe<T extends ZodType<any, any, any, T>>(target: T): ZodPipeline<ZodNull, T>

• Type Parameters

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

  Parameters

  • target: T

  Returns ZodPipeline<ZodNull, T>

promise

• promise(): ZodPromise<ZodNull>

• Returns ZodPromise<ZodNull>

readonly

• readonly(): ZodReadonly<ZodNull>

• Returns ZodReadonly<ZodNull>

refine

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

• Type Parameters

  • RefinedOutput extends null

  Parameters

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

  Returns ZodEffects<ZodNull, RefinedOutput, null>

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

• Parameters

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

  Returns ZodEffects<ZodNull, null, null>

refinement

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

• Type Parameters

  • RefinedOutput extends null

  Parameters

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

  Returns ZodEffects<ZodNull, RefinedOutput, null>

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

• Parameters

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

  Returns ZodEffects<ZodNull, null, null>

safeParse

• safeParse(
      data: unknown,
      params?: Partial<ParseParams>,
  ): SafeParseReturnType<null, null>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns SafeParseReturnType<null, null>

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: Partial<ParseParams>,
  ): Promise<SafeParseReturnType<null, null>>

• Parameters

  • data: unknown
  • Optionalparams: Partial<ParseParams>

  Returns Promise<SafeParseReturnType<null, null>>

superRefine

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

• Type Parameters

  • RefinedOutput extends null

  Parameters

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

  Returns ZodEffects<ZodNull, RefinedOutput, null>

• superRefine(
      refinement: (arg: null, ctx: RefinementCtx) => void,
  ): ZodEffects<ZodNull, null, null>

• Parameters

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

  Returns ZodEffects<ZodNull, null, null>

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

• Parameters

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

  Returns ZodEffects<ZodNull, null, null>

transform

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

• Type Parameters

  • NewOut

  Parameters

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

  Returns ZodEffects<ZodNull, NewOut, null>