Class ZodBranded<T, B>

constructor

• new ZodBranded<T extends ZodTypeAny, B extends string | number | symbol>(def: ZodBrandedDef<T>): ZodBranded<T, B>

• Type Parameters

  • T extends ZodTypeAny
  • B extends string | number | symbol

  Parameters

  • def: ZodBrandedDef<T>

  Returns ZodBranded<T, B>

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

description

• get description(): undefined | string

• Returns undefined | string

_getOrReturnCtx

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

• Parameters

  • input: ParseInput
  • Optional ctx: ParseContext

  Returns ParseContext

_getType

• _getType(input: ParseInput): string

• Parameters

  • input: ParseInput

  Returns string

_parseAsync

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

• Parameters

  • input: ParseInput

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

_parseSync

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

• Parameters

  • input: ParseInput

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

_processInputParams

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

• Parameters

  • input: ParseInput

  Returns {
      ctx: ParseContext;
      status: ParseStatus;
  }

  • ctx: ParseContext

  • status: ParseStatus

_refinement

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

• Parameters

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

      • Parameters

        • arg: T["_output"] & BRAND<B>
        • ctx: RefinementCtx

        Returns any

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

and

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

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • incoming: T

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

array

• array(): ZodArray<ZodBranded<T, B>, "many">

• Returns ZodArray<ZodBranded<T, B>, "many">

brand

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

• Type Parameters

  • B extends string | number | symbol

  Parameters

  • Optional brand: B

  Returns ZodBranded<ZodBranded<T, B>, B>

catch

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

• Parameters

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

  Returns ZodCatch<ZodBranded<T, B>>

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

• Parameters

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

      • Parameters

        • ctx: {
              error: ZodError<any>;
              input: T["_input"];
          }

          • error: ZodError<any>

          • input: T["_input"]

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

  Returns ZodCatch<ZodBranded<T, B>>

default

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

• Parameters

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

  Returns ZodDefault<ZodBranded<T, B>>

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

• Parameters

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

      • Returns noUndefined<T["_input"]>

  Returns ZodDefault<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(): ZodNullable<ZodBranded<T, B>>

• Returns ZodNullable<ZodBranded<T, B>>

nullish

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

• Returns ZodOptional<ZodNullable<ZodBranded<T, B>>>

optional

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

• Returns ZodOptional<ZodBranded<T, B>>

or

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

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • option: T

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

parse

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

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

parseAsync

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

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

pipe

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

• Type Parameters

  • T extends ZodTypeAny

  Parameters

  • target: T

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

promise

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

• Returns ZodPromise<ZodBranded<T, B>>

readonly

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

• Returns ZodReadonly<ZodBranded<T, B>>

refine

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

• Type Parameters

  • RefinedOutput extends any

  Parameters

  • check: ((arg: T["_output"] & BRAND<B>) => arg is RefinedOutput)
    • • (arg: T["_output"] & BRAND<B>): arg is RefinedOutput

      • Parameters

        • arg: T["_output"] & BRAND<B>

        Returns arg is RefinedOutput

  • Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: T["_output"] & BRAND<B>) => Partial<Omit<ZodCustomIssue, "code">>)

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

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

• Parameters

  • check: ((arg: T["_output"] & BRAND<B>) => unknown)
    • • (arg: T["_output"] & BRAND<B>): unknown

      • Parameters

        • arg: T["_output"] & BRAND<B>

        Returns unknown

  • Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: T["_output"] & BRAND<B>) => Partial<Omit<ZodCustomIssue, "code">>)

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

refinement

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

• Type Parameters

  • RefinedOutput extends any

  Parameters

  • check: ((arg: T["_output"] & BRAND<B>) => arg is RefinedOutput)
    • • (arg: T["_output"] & BRAND<B>): arg is RefinedOutput

      • Parameters

        • arg: T["_output"] & BRAND<B>

        Returns arg is RefinedOutput

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

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

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

• Parameters

  • check: ((arg: T["_output"] & BRAND<B>) => boolean)
    • • (arg: T["_output"] & BRAND<B>): boolean

      • Parameters

        • arg: T["_output"] & BRAND<B>

        Returns boolean

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

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

safeParse

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

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

safeParseAsync

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

• Parameters

  • data: unknown
  • Optional params: Partial<ParseParams>

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

superRefine

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

• Type Parameters

  • RefinedOutput extends any

  Parameters

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

      • Parameters

        • arg: T["_output"] & BRAND<B>
        • ctx: RefinementCtx

        Returns arg is RefinedOutput

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

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

• Parameters

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

      • Parameters

        • arg: T["_output"] & BRAND<B>
        • ctx: RefinementCtx

        Returns void

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

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

• Parameters

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

      • Parameters

        • arg: T["_output"] & BRAND<B>
        • ctx: RefinementCtx

        Returns Promise<void>

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

transform

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

• Type Parameters

  • NewOut

  Parameters

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

      • Parameters

        • arg: T["_output"] & BRAND<B>
        • ctx: RefinementCtx

        Returns NewOut | Promise<NewOut>

  Returns ZodEffects<ZodBranded<T, B>, NewOut, T["_input"]>