Class ZodLiteral<T>

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

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<T>

_parseAsync

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

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<T>

parse

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns T

safeParse

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns SafeParseReturnType<T, T>

~validate

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

  Parameters

  • data: unknown

  Returns Result<T> | Promise<Result<T>>

parseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<T>

safeParseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<SafeParseReturnType<T, T>>

refine

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

  Type Parameters

  • RefinedOutput

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, RefinedOutput, T>

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

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, T, T>

refinement

• refinement<RefinedOutput>(
      check: (arg: T) => arg is RefinedOutput,
      refinementData: IssueData | ((arg: T, ctx: RefinementCtx) => IssueData),
  ): ZodEffects<ZodLiteral<T>, RefinedOutput, T>

  Type Parameters

  • RefinedOutput

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, RefinedOutput, T>

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

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, T, T>

_refinement

• _refinement(
      refinement: (arg: T, ctx: RefinementCtx) => any,
  ): ZodEffects<ZodLiteral<T>, T, T>

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, T, T>

superRefine

• superRefine<RefinedOutput>(
      refinement: (arg: T, ctx: RefinementCtx) => arg is RefinedOutput,
  ): ZodEffects<ZodLiteral<T>, RefinedOutput, T>

  Type Parameters

  • RefinedOutput

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, RefinedOutput, T>

• superRefine(
      refinement: (arg: T, ctx: RefinementCtx) => void,
  ): ZodEffects<ZodLiteral<T>, T, T>

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, T, T>

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

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, T, T>

optional

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

  Returns ZodOptional<ZodLiteral<T>>

nullable

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

  Returns ZodNullable<ZodLiteral<T>>

nullish

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

  Returns ZodOptional<ZodNullable<ZodLiteral<T>>>

array

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

  Returns ZodArray<ZodLiteral<T>>

promise

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

  Returns ZodPromise<ZodLiteral<T>>

or

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

and

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodLiteral<T>, T>

transform

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

  Type Parameters

  • NewOut

  Parameters

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

  Returns ZodEffects<ZodLiteral<T>, NewOut>

default

• default(def: noUndefined<T>): ZodDefault<ZodLiteral<T>>

  Parameters

  • def: noUndefined<T>

  Returns ZodDefault<ZodLiteral<T>>

• default(def: () => noUndefined<T>): ZodDefault<ZodLiteral<T>>

  Parameters

  • def: () => noUndefined<T>

  Returns ZodDefault<ZodLiteral<T>>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodLiteral<T>, B>

catch

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

  Parameters

  • def: T

  Returns ZodCatch<ZodLiteral<T>>

• catch(def: (ctx: { error: ZodError; input: T }) => T): ZodCatch<ZodLiteral<T>>

  Parameters

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

  Returns ZodCatch<ZodLiteral<T>>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

pipe

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodLiteral<T>, T>

readonly

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

  Returns ZodReadonly<ZodLiteral<T>>

isOptional

• isOptional(): boolean

  Returns boolean

isNullable

• isNullable(): boolean

  Returns boolean