Class ZodBranded<T, B>

Type Parameters

T extends ZodTypeAny
B extends string | number | symbol

Hierarchy

ZodType<T["_output"] & z.BRAND, ZodBrandedDef<T>, T["_input"]>
- ZodBranded

Index

Constructors

constructor

new ZodBranded<T, B>(def: ZodBrandedDef<T>): ZodBranded<T, B>
Type Parameters
- T extends ZodType<any, any, any, T>
- B extends string | number | symbol
Parameters
- def: ZodBrandedDef<T>
Returns ZodBranded<T, B>
Inherited from ZodType.constructor
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:72

Properties

`Readonly` _def

_def: ZodBrandedDef<T>

`Readonly` _input

_input: T["_input"]

`Readonly` _output

_output: T["_output"] & z.BRAND

`Readonly` _type

_type: T["_output"] & z.BRAND

spa

spa: ((data: unknown, params?: Partial<ParseParams>) => Promise<SafeParseReturnType<T["_input"], T["_output"] & z.BRAND>>)

Type declaration

- (data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<T["_input"], T["_output"] & z.BRAND>>
- Alias of safeParseAsync
 Parameters
 - data: unknown
 - Optional params: Partial<ParseParams>
 Returns Promise<SafeParseReturnType<T["_input"], T["_output"] & z.BRAND>>

Accessors

description

get description(): undefined | string
Returns undefined | string
Inherited from ZodType.description
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:49

Methods

_getOrReturnCtx

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext): ParseContext
Parameters
- input: ParseInput
- Optional ctx: ParseContext
Returns ParseContext
Inherited from ZodType._getOrReturnCtx
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:52

_getType

_getType(input: ParseInput): string
Parameters
- input: ParseInput
Returns string
Inherited from ZodType._getType
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:51

_parse

_parse(input: ParseInput): ParseReturnType<any>
Parameters
- input: ParseInput
Returns ParseReturnType<any>
Overrides ZodType._parse
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:785

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<T["_output"] & z.BRAND>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<T["_output"] & z.BRAND>
Inherited from ZodType._parseAsync
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<T["_output"] & z.BRAND>
Parameters
- input: ParseInput
Returns SyncParseReturnType<T["_output"] & z.BRAND>
Inherited from ZodType._parseSync
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:57

_processInputParams

_processInputParams(input: ParseInput): {
ctx: ParseContext;
status: ParseStatus;
}
Parameters
- input: ParseInput
Returns {
ctx: ParseContext;
status: ParseStatus;
}
- ctx: ParseContext
- status: ParseStatus
Inherited from ZodType._processInputParams
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:53

_refinement

_refinement(refinement: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => any)): ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Parameters
- refinement: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => any)
 - - (arg: T["_output"] & z.BRAND, ctx: RefinementCtx): any
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 ctx: RefinementCtx
 
 Returns any
Returns ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Inherited from ZodType._refinement
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:69

and

and<T>(incoming: T): ZodIntersection<ZodBranded<T, B>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodBranded<T, B>, T>
Inherited from ZodType.and
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:79

array

array(): ZodArray<ZodBranded<T, B>, "many">
Returns ZodArray<ZodBranded<T, B>, "many">
Inherited from ZodType.array
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:76

brand

brand(brand?: B): ZodBranded<ZodBranded<T, B>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<ZodBranded<T, B>, B>
Inherited from ZodType.brand
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:83

catch

catch(def: T["_input"]): ZodCatch<ZodBranded<T, B>>
Parameters
- def: T["_input"]
Returns ZodCatch<ZodBranded<T, B>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:84
catch(def: (() => T["_input"])): ZodCatch<ZodBranded<T, B>>
Parameters
- def: (() => T["_input"])
 - - (): T["_input"]
 - Returns T["_input"]
Returns ZodCatch<ZodBranded<T, B>>
Inherited from ZodType.catch
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:85

default

default(def: noUndefined<T["_input"]>): ZodDefault<ZodBranded<T, B>>
Parameters
- def: noUndefined<T["_input"]>
Returns ZodDefault<ZodBranded<T, B>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:81
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>>
Inherited from ZodType.default
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:82

describe

describe(description: string): ZodBranded<T, B>
Parameters
- description: string
Returns ZodBranded<T, B>
Inherited from ZodType.describe
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:86

isNullable

isNullable(): boolean
Returns boolean
Inherited from ZodType.isNullable
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:89

isOptional

isOptional(): boolean
Returns boolean
Inherited from ZodType.isOptional
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:88

nullable

nullable(): ZodNullable<ZodBranded<T, B>>
Returns ZodNullable<ZodBranded<T, B>>
Inherited from ZodType.nullable
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:74

nullish

nullish(): ZodNullable<ZodOptional<ZodBranded<T, B>>>
Returns ZodNullable<ZodOptional<ZodBranded<T, B>>>
Inherited from ZodType.nullish
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:75

optional

optional(): ZodOptional<ZodBranded<T, B>>
Returns ZodOptional<ZodBranded<T, B>>
Inherited from ZodType.optional
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:73

or

or<T>(option: T): ZodUnion<[ZodBranded<T, B>, T]>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- option: T
Returns ZodUnion<[ZodBranded<T, B>, T]>
Inherited from ZodType.or
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:78

parse

parse(data: unknown, params?: Partial<ParseParams>): T["_output"] & z.BRAND
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns T["_output"] & z.BRAND
Inherited from ZodType.parse
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:59

parseAsync

parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<T["_output"] & z.BRAND>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<T["_output"] & z.BRAND>
Inherited from ZodType.parseAsync
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:61

pipe

pipe<T>(target: T): ZodPipeline<ZodBranded<T, B>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- target: T
Returns ZodPipeline<ZodBranded<T, B>, T>
Inherited from ZodType.pipe
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:87

promise

promise(): ZodPromise<ZodBranded<T, B>>
Returns ZodPromise<ZodBranded<T, B>>
Inherited from ZodType.promise
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:77

refine

refine<RefinedOutput>(check: ((arg: T["_output"] & z.BRAND) => arg is RefinedOutput), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: T["_output"] & z.BRAND) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- check: ((arg: T["_output"] & z.BRAND) => arg is RefinedOutput)
 - - (arg: T["_output"] & z.BRAND): arg is RefinedOutput
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 Returns arg is RefinedOutput
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: T["_output"] & z.BRAND) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:65
refine(check: ((arg: T["_output"] & z.BRAND) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: T["_output"] & z.BRAND) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Parameters
- check: ((arg: T["_output"] & z.BRAND) => unknown)
 - - (arg: T["_output"] & z.BRAND): unknown
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: T["_output"] & z.BRAND) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Inherited from ZodType.refine
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:66

refinement

refinement<RefinedOutput>(check: ((arg: T["_output"] & z.BRAND) => arg is RefinedOutput), refinementData: IssueData | ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- check: ((arg: T["_output"] & z.BRAND) => arg is RefinedOutput)
 - - (arg: T["_output"] & z.BRAND): arg is RefinedOutput
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 Returns arg is RefinedOutput
- refinementData: IssueData | ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:67
refinement(check: ((arg: T["_output"] & z.BRAND) => boolean), refinementData: IssueData | ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Parameters
- check: ((arg: T["_output"] & z.BRAND) => boolean)
 - - (arg: T["_output"] & z.BRAND): boolean
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 Returns boolean
- refinementData: IssueData | ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Inherited from ZodType.refinement
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:68

safeParse

safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<T["_input"], T["_output"] & z.BRAND>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<T["_input"], T["_output"] & z.BRAND>
Inherited from ZodType.safeParse
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<T["_input"], T["_output"] & z.BRAND>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<T["_input"], T["_output"] & z.BRAND>>
Inherited from ZodType.safeParseAsync
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:62

superRefine

superRefine<RefinedOutput>(refinement: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>
Type Parameters
- RefinedOutput extends any
Parameters
- refinement: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => arg is RefinedOutput)
 - - (arg: T["_output"] & z.BRAND, ctx: RefinementCtx): arg is RefinedOutput
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 ctx: RefinementCtx
 
 Returns arg is RefinedOutput
Returns ZodEffects<ZodBranded<T, B>, RefinedOutput, T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:70
superRefine(refinement: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => void)): ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Parameters
- refinement: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => void)
 - - (arg: T["_output"] & z.BRAND, ctx: RefinementCtx): void
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 ctx: RefinementCtx
 
 Returns void
Returns ZodEffects<ZodBranded<T, B>, T["_output"] & z.BRAND, T["_input"]>
Inherited from ZodType.superRefine
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:71

transform

transform<NewOut>(transform: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => NewOut | Promise<NewOut>)): ZodEffects<ZodBranded<T, B>, NewOut, T["_input"]>
Type Parameters
- NewOut
Parameters
- transform: ((arg: T["_output"] & z.BRAND, ctx: RefinementCtx) => NewOut | Promise<NewOut>)
 - - (arg: T["_output"] & z.BRAND, ctx: RefinementCtx): NewOut | Promise<NewOut>
 - Parameters
 
 arg: T["_output"] & z.BRAND
 
 ctx: RefinementCtx
 
 Returns NewOut | Promise<NewOut>
Returns ZodEffects<ZodBranded<T, B>, NewOut, T["_input"]>
Inherited from ZodType.transform
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:80

unwrap

unwrap(): T
Returns T
- Defined in node_modules/.pnpm/zod@3.20.2/node_modules/zod/lib/types.d.ts:786

Class ZodBranded<T, B>

Type Parameters

T extends ZodTypeAny

B extends string | number | symbol

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends ZodType<any, any, any, T>

B extends string | number | symbol

Parameters

def: ZodBrandedDef<T>

Returns ZodBranded<T, B>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

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

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

input: ParseInput

Optional ctx: ParseContext

Returns ParseContext

_getType

Parameters

input: ParseInput

Returns string

_parse

Parameters

input: ParseInput

Returns ParseReturnType<any>

_parseAsync

Parameters

input: ParseInput

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

_parseSync

Parameters

input: ParseInput

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

_processInputParams

Parameters

input: ParseInput

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

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

Parameters

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

ctx: RefinementCtx

Returns any

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

and

Type Parameters

T extends ZodType<any, any, any, T>

Parameters

incoming: T

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

array

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

brand

Type Parameters

B extends string | number | symbol

Parameters

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Optional` params: Partial<ParseParams>

`Optional` ctx: ParseContext

Returns {
ctx: ParseContext;
status: ParseStatus;
}

`Optional` brand: B

`Optional` params: Partial<ParseParams>

`Optional` params: Partial<ParseParams>

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