Class ZodBranded<T, B>

Readonly_def

Readonly_input

Readonly_output

Readonly_type

spa

description

• get description(): undefined | string

  Returns undefined | string

_getOrReturnCtx

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

  Parameters

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

  Returns Zod.ParseContext

_getType

• _getType(input: Zod.ParseInput): string

  Parameters

  • input: Zod.ParseInput

  Returns string

_parseAsync

• _parseAsync(
      input: Zod.ParseInput,
  ): Zod.AsyncParseReturnType<T["_output"] & Zod.BRAND<B>>

  Parameters

  • input: Zod.ParseInput

  Returns Zod.AsyncParseReturnType<T["_output"] & Zod.BRAND<B>>

_parseSync

• _parseSync(
      input: Zod.ParseInput,
  ): Zod.SyncParseReturnType<T["_output"] & Zod.BRAND<B>>

  Parameters

  • input: Zod.ParseInput

  Returns Zod.SyncParseReturnType<T["_output"] & Zod.BRAND<B>>

_processInputParams

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

  Parameters

  • input: Zod.ParseInput

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

_refinement

• _refinement(
      refinement: (
          arg: T["_output"] & Zod.BRAND<B>,
          ctx: Zod.RefinementCtx,
      ) => any,
  ): Zod.ZodEffects<
      Zod.ZodBranded<T, B>,
      T["_output"] & Zod.BRAND<B>,
      T["_input"],
  >

  Parameters

  • refinement: (arg: T["_output"] & Zod.BRAND<B>, ctx: Zod.RefinementCtx) => any

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, T["_output"] & Zod.BRAND<B>, T["_input"]>

and

• and<T extends Zod.ZodTypeAny>(
      incoming: T,
  ): Zod.ZodIntersection<Zod.ZodBranded<T, B>, T>

  Type Parameters

  • T extends Zod.ZodTypeAny

  Parameters

  • incoming: T

  Returns Zod.ZodIntersection<Zod.ZodBranded<T, B>, T>

array

• array(): Zod.ZodArray<Zod.ZodBranded<T, B>>

  Returns Zod.ZodArray<Zod.ZodBranded<T, B>>

brand

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

  Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optionalbrand: B

  Returns Zod.ZodBranded<Zod.ZodBranded<T, B>, B>

catch

• catch(def: T["_output"] & Zod.BRAND<B>): Zod.ZodCatch<Zod.ZodBranded<T, B>>

  Parameters

  • def: T["_output"] & Zod.BRAND<B>

  Returns Zod.ZodCatch<Zod.ZodBranded<T, B>>

• catch(
      def: (
          ctx: { error: Zod.ZodError; input: T["_input"] },
      ) => T["_output"] & Zod.BRAND<B>,
  ): Zod.ZodCatch<Zod.ZodBranded<T, B>>

  Parameters

  • def: (
        ctx: { error: Zod.ZodError; input: T["_input"] },
    ) => T["_output"] & Zod.BRAND<B>

  Returns Zod.ZodCatch<Zod.ZodBranded<T, B>>

default

• default(def: noUndefined<T["_input"]>): Zod.ZodDefault<Zod.ZodBranded<T, B>>

  Parameters

  • def: noUndefined<T["_input"]>

  Returns Zod.ZodDefault<Zod.ZodBranded<T, B>>

• default(
      def: () => noUndefined<T["_input"]>,
  ): Zod.ZodDefault<Zod.ZodBranded<T, B>>

  Parameters

  • def: () => noUndefined<T["_input"]>

  Returns Zod.ZodDefault<Zod.ZodBranded<T, B>>

describe

• describe(description: string): this

  Parameters

  • description: string

  Returns this

isNullable

• isNullable(): boolean

  Returns boolean

isOptional

• isOptional(): boolean

  Returns boolean

nullable

• nullable(): Zod.ZodNullable<Zod.ZodBranded<T, B>>

  Returns Zod.ZodNullable<Zod.ZodBranded<T, B>>

nullish

• nullish(): Zod.ZodOptional<Zod.ZodNullable<Zod.ZodBranded<T, B>>>

  Returns Zod.ZodOptional<Zod.ZodNullable<Zod.ZodBranded<T, B>>>

optional

• optional(): Zod.ZodOptional<Zod.ZodBranded<T, B>>

  Returns Zod.ZodOptional<Zod.ZodBranded<T, B>>

or

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

  Type Parameters

  • T extends Zod.ZodTypeAny

  Parameters

  • option: T

  Returns Zod.ZodUnion<[Zod.ZodBranded<T, B>, T]>

parse

• parse(
      data: unknown,
      params?: Partial<Zod.ParseParams>,
  ): T["_output"] & Zod.BRAND<B>

  Parameters

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

  Returns T["_output"] & Zod.BRAND<B>

parseAsync

• parseAsync(
      data: unknown,
      params?: Partial<Zod.ParseParams>,
  ): Promise<T["_output"] & Zod.BRAND<B>>

  Parameters

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

  Returns Promise<T["_output"] & Zod.BRAND<B>>

pipe

• pipe<T extends Zod.ZodTypeAny>(
      target: T,
  ): Zod.ZodPipeline<Zod.ZodBranded<T, B>, T>

  Type Parameters

  • T extends Zod.ZodTypeAny

  Parameters

  • target: T

  Returns Zod.ZodPipeline<Zod.ZodBranded<T, B>, T>

promise

• promise(): Zod.ZodPromise<Zod.ZodBranded<T, B>>

  Returns Zod.ZodPromise<Zod.ZodBranded<T, B>>

readonly

• readonly(): Zod.ZodReadonly<Zod.ZodBranded<T, B>>

  Returns Zod.ZodReadonly<Zod.ZodBranded<T, B>>

refine

• refine<RefinedOutput extends any>(
      check: (arg: T["_output"] & Zod.BRAND<B>) => arg is RefinedOutput,
      message?:
          | string
          | Partial<Omit<Zod.ZodCustomIssue, "code">>
          | ((arg: T["_output"] & Zod.BRAND<B>) => Zod.CustomErrorParams),
  ): Zod.ZodEffects<Zod.ZodBranded<T, B>, RefinedOutput, T["_input"]>

  Type Parameters

  • RefinedOutput extends any

  Parameters

  • check: (arg: T["_output"] & Zod.BRAND<B>) => arg is RefinedOutput
  • Optionalmessage:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: T["_output"] & Zod.BRAND<B>) => Zod.CustomErrorParams)

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, RefinedOutput, T["_input"]>

• refine(
      check: (arg: T["_output"] & Zod.BRAND<B>) => unknown,
      message?:
          | string
          | Partial<Omit<Zod.ZodCustomIssue, "code">>
          | ((arg: T["_output"] & Zod.BRAND<B>) => Zod.CustomErrorParams),
  ): Zod.ZodEffects<
      Zod.ZodBranded<T, B>,
      T["_output"] & Zod.BRAND<B>,
      T["_input"],
  >

  Parameters

  • check: (arg: T["_output"] & Zod.BRAND<B>) => unknown
  • Optionalmessage:
        | string
        | Partial<Omit<Zod.ZodCustomIssue, "code">>
        | ((arg: T["_output"] & Zod.BRAND<B>) => Zod.CustomErrorParams)

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, T["_output"] & Zod.BRAND<B>, T["_input"]>

refinement

• refinement<RefinedOutput extends any>(
      check: (arg: T["_output"] & Zod.BRAND<B>) => arg is RefinedOutput,
      refinementData:
          | Zod.IssueData
          | (
              (
                  arg: T["_output"] & Zod.BRAND<B>,
                  ctx: Zod.RefinementCtx,
              ) => Zod.IssueData
          ),
  ): Zod.ZodEffects<Zod.ZodBranded<T, B>, RefinedOutput, T["_input"]>

  Type Parameters

  • RefinedOutput extends any

  Parameters

  • check: (arg: T["_output"] & Zod.BRAND<B>) => arg is RefinedOutput
  • refinementData:
        | Zod.IssueData
        | (
            (
                arg: T["_output"] & Zod.BRAND<B>,
                ctx: Zod.RefinementCtx,
            ) => Zod.IssueData
        )

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, RefinedOutput, T["_input"]>

• refinement(
      check: (arg: T["_output"] & Zod.BRAND<B>) => boolean,
      refinementData:
          | Zod.IssueData
          | (
              (
                  arg: T["_output"] & Zod.BRAND<B>,
                  ctx: Zod.RefinementCtx,
              ) => Zod.IssueData
          ),
  ): Zod.ZodEffects<
      Zod.ZodBranded<T, B>,
      T["_output"] & Zod.BRAND<B>,
      T["_input"],
  >

  Parameters

  • check: (arg: T["_output"] & Zod.BRAND<B>) => boolean
  • refinementData:
        | Zod.IssueData
        | (
            (
                arg: T["_output"] & Zod.BRAND<B>,
                ctx: Zod.RefinementCtx,
            ) => Zod.IssueData
        )

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, T["_output"] & Zod.BRAND<B>, T["_input"]>

safeParse

• safeParse(
      data: unknown,
      params?: Partial<Zod.ParseParams>,
  ): Zod.SafeParseReturnType<T["_input"], T["_output"] & Zod.BRAND<B>>

  Parameters

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

  Returns Zod.SafeParseReturnType<T["_input"], T["_output"] & Zod.BRAND<B>>

safeParseAsync

• safeParseAsync(
      data: unknown,
      params?: Partial<Zod.ParseParams>,
  ): Promise<
      Zod.SafeParseReturnType<T["_input"], T["_output"] & Zod.BRAND<B>>,
  >

  Parameters

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

  Returns Promise<Zod.SafeParseReturnType<T["_input"], T["_output"] & Zod.BRAND<B>>>

superRefine

• superRefine<RefinedOutput extends any>(
      refinement: (
          arg: T["_output"] & Zod.BRAND<B>,
          ctx: Zod.RefinementCtx,
      ) => arg is RefinedOutput,
  ): Zod.ZodEffects<Zod.ZodBranded<T, B>, RefinedOutput, T["_input"]>

  Type Parameters

  • RefinedOutput extends any

  Parameters

  • refinement: (
        arg: T["_output"] & Zod.BRAND<B>,
        ctx: Zod.RefinementCtx,
    ) => arg is RefinedOutput

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, RefinedOutput, T["_input"]>

• superRefine(
      refinement: (
          arg: T["_output"] & Zod.BRAND<B>,
          ctx: Zod.RefinementCtx,
      ) => void,
  ): Zod.ZodEffects<
      Zod.ZodBranded<T, B>,
      T["_output"] & Zod.BRAND<B>,
      T["_input"],
  >

  Parameters

  • refinement: (arg: T["_output"] & Zod.BRAND<B>, ctx: Zod.RefinementCtx) => void

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, T["_output"] & Zod.BRAND<B>, T["_input"]>

• superRefine(
      refinement: (
          arg: T["_output"] & Zod.BRAND<B>,
          ctx: Zod.RefinementCtx,
      ) => Promise<void>,
  ): Zod.ZodEffects<
      Zod.ZodBranded<T, B>,
      T["_output"] & Zod.BRAND<B>,
      T["_input"],
  >

  Parameters

  • refinement: (arg: T["_output"] & Zod.BRAND<B>, ctx: Zod.RefinementCtx) => Promise<void>

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, T["_output"] & Zod.BRAND<B>, T["_input"]>

transform

• transform<NewOut>(
      transform: (
          arg: T["_output"] & Zod.BRAND<B>,
          ctx: Zod.RefinementCtx,
      ) => NewOut | Promise<NewOut>,
  ): Zod.ZodEffects<Zod.ZodBranded<T, B>, NewOut>

  Type Parameters

  • NewOut

  Parameters

  • transform: (
        arg: T["_output"] & Zod.BRAND<B>,
        ctx: Zod.RefinementCtx,
    ) => NewOut | Promise<NewOut>

  Returns Zod.ZodEffects<Zod.ZodBranded<T, B>, NewOut>