Class ZodSymbol

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

description

• get description(): undefined | string

• Returns undefined | string

_getOrReturnCtx

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

• Parameters

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

  Returns Zod.z.ParseContext

_getType

• _getType(input: Zod.z.ParseInput): string

• Parameters

  • input: Zod.z.ParseInput

  Returns string

_parseAsync

• _parseAsync(input: Zod.z.ParseInput): Zod.z.AsyncParseReturnType<symbol>

• Parameters

  • input: Zod.z.ParseInput

  Returns Zod.z.AsyncParseReturnType<symbol>

_parseSync

• _parseSync(input: Zod.z.ParseInput): Zod.z.SyncParseReturnType<symbol>

• Parameters

  • input: Zod.z.ParseInput

  Returns Zod.z.SyncParseReturnType<symbol>

_processInputParams

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

• Parameters

  • input: Zod.z.ParseInput

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

_refinement

• _refinement(
      refinement: (arg: symbol, ctx: Zod.z.RefinementCtx) => any,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

• Parameters

  • refinement: (arg: symbol, ctx: Zod.z.RefinementCtx) => any

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

and

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

• Type Parameters

  • T extends Zod.z.ZodTypeAny

  Parameters

  • incoming: T

  Returns Zod.z.ZodIntersection<Zod.z.ZodSymbol, T>

array

• array(): Zod.z.ZodArray<Zod.z.ZodSymbol, "many">

• Returns Zod.z.ZodArray<Zod.z.ZodSymbol, "many">

brand

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

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns Zod.z.ZodBranded<Zod.z.ZodSymbol, B>

catch

• catch(def: symbol): Zod.z.ZodCatch<Zod.z.ZodSymbol>

• Parameters

  • def: symbol

  Returns Zod.z.ZodCatch<Zod.z.ZodSymbol>

• catch(
      def: (ctx: { error: Zod.z.ZodError<any>; input: symbol }) => symbol,
  ): Zod.z.ZodCatch<Zod.z.ZodSymbol>

• Parameters

  • def: (ctx: { error: Zod.z.ZodError<any>; input: symbol }) => symbol

  Returns Zod.z.ZodCatch<Zod.z.ZodSymbol>

default

• default(def: symbol): Zod.z.ZodDefault<Zod.z.ZodSymbol>

• Parameters

  • def: symbol

  Returns Zod.z.ZodDefault<Zod.z.ZodSymbol>

• default(def: () => symbol): Zod.z.ZodDefault<Zod.z.ZodSymbol>

• Parameters

  • def: () => symbol

  Returns Zod.z.ZodDefault<Zod.z.ZodSymbol>

describe

• describe(description: string): this

• Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

• Returns boolean

isOptional

• isOptional(): boolean

• Returns boolean

nullable

• nullable(): Zod.z.ZodNullable<Zod.z.ZodSymbol>

• Returns Zod.z.ZodNullable<Zod.z.ZodSymbol>

nullish

• nullish(): Zod.z.ZodOptional<Zod.z.ZodNullable<Zod.z.ZodSymbol>>

• Returns Zod.z.ZodOptional<Zod.z.ZodNullable<Zod.z.ZodSymbol>>

optional

• optional(): Zod.z.ZodOptional<Zod.z.ZodSymbol>

• Returns Zod.z.ZodOptional<Zod.z.ZodSymbol>

or

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

• Type Parameters

  • T extends Zod.z.ZodTypeAny

  Parameters

  • option: T

  Returns Zod.z.ZodUnion<[Zod.z.ZodSymbol, T]>

parse

• parse(data: unknown, params?: Partial<Zod.z.ParseParams>): symbol

• Parameters

  • data: unknown
  • Optionalparams: Partial<Zod.z.ParseParams>

  Returns symbol

parseAsync

• parseAsync(data: unknown, params?: Partial<Zod.z.ParseParams>): Promise<symbol>

• Parameters

  • data: unknown
  • Optionalparams: Partial<Zod.z.ParseParams>

  Returns Promise<symbol>

pipe

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

• Type Parameters

  • T extends Zod.z.ZodTypeAny

  Parameters

  • target: T

  Returns Zod.z.ZodPipeline<Zod.z.ZodSymbol, T>

promise

• promise(): Zod.z.ZodPromise<Zod.z.ZodSymbol>

• Returns Zod.z.ZodPromise<Zod.z.ZodSymbol>

readonly

• readonly(): Zod.z.ZodReadonly<Zod.z.ZodSymbol>

• Returns Zod.z.ZodReadonly<Zod.z.ZodSymbol>

refine

• refine<RefinedOutput extends symbol>(
      check: (arg: symbol) => arg is RefinedOutput,
      message?:
          | string
          | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
          | (arg: symbol) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, RefinedOutput, symbol>

• Type Parameters

  • RefinedOutput extends symbol

  Parameters

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

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, RefinedOutput, symbol>

• refine(
      check: (arg: symbol) => unknown,
      message?:
          | string
          | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
          | (arg: symbol) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

• Parameters

  • check: (arg: symbol) => unknown
  • Optionalmessage:
        | string
        | Partial<Omit<Zod.z.ZodCustomIssue, "code">>
        | (arg: symbol) => Partial<Omit<Zod.z.ZodCustomIssue, "code">>

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

refinement

• refinement<RefinedOutput extends symbol>(
      check: (arg: symbol) => arg is RefinedOutput,
      refinementData:
          | Zod.z.IssueData
          | (arg: symbol, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, RefinedOutput, symbol>

• Type Parameters

  • RefinedOutput extends symbol

  Parameters

  • check: (arg: symbol) => arg is RefinedOutput
  • refinementData: Zod.z.IssueData | (arg: symbol, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, RefinedOutput, symbol>

• refinement(
      check: (arg: symbol) => boolean,
      refinementData:
          | Zod.z.IssueData
          | (arg: symbol, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

• Parameters

  • check: (arg: symbol) => boolean
  • refinementData: Zod.z.IssueData | (arg: symbol, ctx: Zod.z.RefinementCtx) => Zod.z.IssueData

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

safeParse

• safeParse(
      data: unknown,
      params?: Partial<Zod.z.ParseParams>,
  ): Zod.z.SafeParseReturnType<symbol, symbol>

• Parameters

  • data: unknown
  • Optionalparams: Partial<Zod.z.ParseParams>

  Returns Zod.z.SafeParseReturnType<symbol, symbol>

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: Partial<Zod.z.ParseParams>,
  ): Promise<Zod.z.SafeParseReturnType<symbol, symbol>>

• Parameters

  • data: unknown
  • Optionalparams: Partial<Zod.z.ParseParams>

  Returns Promise<Zod.z.SafeParseReturnType<symbol, symbol>>

superRefine

• superRefine<RefinedOutput extends symbol>(
      refinement: (
          arg: symbol,
          ctx: Zod.z.RefinementCtx,
      ) => arg is RefinedOutput,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, RefinedOutput, symbol>

• Type Parameters

  • RefinedOutput extends symbol

  Parameters

  • refinement: (arg: symbol, ctx: Zod.z.RefinementCtx) => arg is RefinedOutput

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, RefinedOutput, symbol>

• superRefine(
      refinement: (arg: symbol, ctx: Zod.z.RefinementCtx) => void,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

• Parameters

  • refinement: (arg: symbol, ctx: Zod.z.RefinementCtx) => void

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

• superRefine(
      refinement: (arg: symbol, ctx: Zod.z.RefinementCtx) => Promise<void>,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

• Parameters

  • refinement: (arg: symbol, ctx: Zod.z.RefinementCtx) => Promise<void>

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, symbol, symbol>

transform

• transform<NewOut>(
      transform: (
          arg: symbol,
          ctx: Zod.z.RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): Zod.z.ZodEffects<Zod.z.ZodSymbol, NewOut, symbol>

• Type Parameters

  • NewOut

  Parameters

  • transform: (arg: symbol, ctx: Zod.z.RefinementCtx) => NewOut | Promise<NewOut>

  Returns Zod.z.ZodEffects<Zod.z.ZodSymbol, NewOut, symbol>