Class ZodNull

Readonly_type

Readonly_output

Readonly_input

Readonly_def

~standard

spa

description

• get description(): undefined | string

  Returns undefined | string

_getType

• _getType(input: ParseInput): string

  Parameters

  • input: ParseInput

  Returns string

_getOrReturnCtx

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

  Parameters

  • input: ParseInput
  • Optionalctx: ParseContext

  Returns ParseContext

_processInputParams

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

  Parameters

  • input: ParseInput

  Returns { status: ParseStatus; ctx: ParseContext }

_parseSync

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

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<null>

_parseAsync

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

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<null>

parse

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns null

safeParse

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns SafeParseReturnType<null, null>

~validate

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

  Parameters

  • data: unknown

  Returns Result<null> | Promise<Result<null>>

parseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<null>

safeParseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<SafeParseReturnType<null, null>>

refine

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

  Type Parameters

  • RefinedOutput extends null

  Parameters

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

  Returns ZodEffects<ZodNull, RefinedOutput, null>

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

  Parameters

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

  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>

_refinement

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

  Parameters

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

  Returns ZodEffects<ZodNull, 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>

optional

• optional(): ZodOptional<ZodNull>

  Returns ZodOptional<ZodNull>

nullable

• nullable(): ZodNullable<ZodNull>

  Returns ZodNullable<ZodNull>

nullish

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

  Returns ZodOptional<ZodNullable<ZodNull>>

array

• array(): ZodArray<ZodNull>

  Returns ZodArray<ZodNull>

promise

• promise(): ZodPromise<ZodNull>

  Returns ZodPromise<ZodNull>

or

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

  Returns ZodUnion<[ZodNull, T]>

and

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodNull, T>

transform

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

  Type Parameters

  • NewOut

  Parameters

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

  Returns ZodEffects<ZodNull, NewOut>

default

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

  Parameters

  • def: null

  Returns ZodDefault<ZodNull>

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

  Parameters

  • def: () => null

  Returns ZodDefault<ZodNull>

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; input: null }) => null): ZodCatch<ZodNull>

  Parameters

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

  Returns ZodCatch<ZodNull>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

pipe

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodNull, T>

readonly

• readonly(): ZodReadonly<ZodNull>

  Returns ZodReadonly<ZodNull>

isOptional

• isOptional(): boolean

  Returns boolean

isNullable

• isNullable(): boolean

  Returns boolean