Class ZodSymbol

constructor

• new ZodSymbol(def: ZodSymbolDef): ZodSymbol

  Parameters

  • def: ZodSymbolDef

  Returns ZodSymbol

Readonly_def

Readonly_input

Readonly_output

Readonly_type

~standard

spa

Staticcreate

description

• get description(): string | undefined

  Returns string | undefined

_getOrReturnCtx

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

  Parameters

  • input: ParseInput
  • Optionalctx: ParseContext

  Returns ParseContext

_getType

• _getType(input: ParseInput): string

  Parameters

  • input: ParseInput

  Returns string

_parse

• _parse(input: ParseInput): ParseReturnType<symbol>

  Parameters

  • input: ParseInput

  Returns ParseReturnType<symbol>

_parseAsync

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

  Parameters

  • input: ParseInput

  Returns AsyncParseReturnType<symbol>

_parseSync

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

  Parameters

  • input: ParseInput

  Returns SyncParseReturnType<symbol>

_processInputParams

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

  Parameters

  • input: ParseInput

  Returns { ctx: ParseContext; status: ParseStatus }

_refinement

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

  Parameters

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

  Returns ZodEffects<ZodSymbol, symbol, symbol>

~validate

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

  Parameters

  • data: unknown

  Returns Result<symbol> | Promise<Result<symbol>>

and

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

  Returns ZodIntersection<ZodSymbol, T>

array

• array(): ZodArray<ZodSymbol>

  Returns ZodArray<ZodSymbol>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns ZodBranded<ZodSymbol, B>

catch

• catch(def: symbol): ZodCatch<ZodSymbol>

  Parameters

  • def: symbol

  Returns ZodCatch<ZodSymbol>

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

  Parameters

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

  Returns ZodCatch<ZodSymbol>

default

• default(def: symbol): ZodDefault<ZodSymbol>

  Parameters

  • def: symbol

  Returns ZodDefault<ZodSymbol>

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

  Parameters

  • def: () => symbol

  Returns ZodDefault<ZodSymbol>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

  Returns boolean

isOptional

• isOptional(): boolean

  Returns boolean

nullable

• nullable(): ZodNullable<ZodSymbol>

  Returns ZodNullable<ZodSymbol>

nullish

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

  Returns ZodOptional<ZodNullable<ZodSymbol>>

optional

• optional(): ZodOptional<ZodSymbol>

  Returns ZodOptional<ZodSymbol>

or

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

  Returns ZodUnion<[ZodSymbol, T]>

parse

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns symbol

parseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<symbol>

pipe

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

  Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

  Returns ZodPipeline<ZodSymbol, T>

promise

• promise(): ZodPromise<ZodSymbol>

  Returns ZodPromise<ZodSymbol>

readonly

• readonly(): ZodReadonly<ZodSymbol>

  Returns ZodReadonly<ZodSymbol>

refine

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

  Type Parameters

  • RefinedOutput extends symbol

  Parameters

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

  Returns ZodEffects<ZodSymbol, RefinedOutput, symbol>

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

  Parameters

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

  Returns ZodEffects<ZodSymbol, symbol, symbol>

refinement

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

  Type Parameters

  • RefinedOutput extends symbol

  Parameters

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

  Returns ZodEffects<ZodSymbol, RefinedOutput, symbol>

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

  Parameters

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

  Returns ZodEffects<ZodSymbol, symbol, symbol>

safeParse

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns SafeParseReturnType<symbol, symbol>

safeParseAsync

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

  Parameters

  • data: unknown
  • Optionalparams: InexactPartial<ParseParams>

  Returns Promise<SafeParseReturnType<symbol, symbol>>

superRefine

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

  Type Parameters

  • RefinedOutput extends symbol

  Parameters

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

  Returns ZodEffects<ZodSymbol, RefinedOutput, symbol>

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

  Parameters

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

  Returns ZodEffects<ZodSymbol, symbol, symbol>

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

  Parameters

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

  Returns ZodEffects<ZodSymbol, symbol, symbol>

transform

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

  Type Parameters

  • NewOut

  Parameters

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

  Returns ZodEffects<ZodSymbol, NewOut>