Class ZodBranded<T, B>

Type Parameters

T extends ZodTypeAny
B extends string | number | symbol

Hierarchy (view full)

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

Index

Constructors

constructor

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

Properties

`Readonly` _def

_def: ZodBrandedDef<T>

`Readonly` _input

_input: T["_input"]

`Readonly` _output

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

`Readonly` _type

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

spa

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

Alias of safeParseAsync

Type declaration

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

Accessors

description

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

Methods

_getOrReturnCtx

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

_getType

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

_parse

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

_parseAsync

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

_parseSync

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

_processInputParams

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

_refinement

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

and

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

array

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

brand

brand(brand?): 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/zod/lib/types.d.ts:84

catch

catch(def): ZodCatch<ZodBranded<T, B>>
Parameters
- def: T["_output"] & Zod.z.BRAND
Returns ZodCatch<ZodBranded<T, B>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:85
catch(def): ZodCatch<ZodBranded<T, B>>
Parameters
- def: ((ctx) => T["_output"] & Zod.z.BRAND)
 - - (ctx): T["_output"] & Zod.z.BRAND
 - Parameters
 ctx: {
 error: ZodError<any>;
 input: T["_input"];
 }
 error: ZodError<any>
 input: T["_input"]
 Returns T["_output"] & Zod.z.BRAND
Returns ZodCatch<ZodBranded<T, B>>
Inherited from ZodType.catch
- Defined in node_modules/zod/lib/types.d.ts:86

default

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

describe

describe(description): this
Parameters
- description: string
Returns this
Inherited from ZodType.describe
- Defined in node_modules/zod/lib/types.d.ts:90

isNullable

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

isOptional

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

nullable

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

nullish

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

optional

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

or

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

parse

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

parseAsync

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

pipe

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

promise

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

readonly

readonly(): ZodReadonly<ZodBranded<T, B>>
Returns ZodReadonly<ZodBranded<T, B>>
Inherited from ZodType.readonly
- Defined in node_modules/zod/lib/types.d.ts:92

refine

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

refinement

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

safeParse

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

safeParseAsync

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

superRefine

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

transform

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

unwrap

unwrap(): T
Returns T
- Defined in node_modules/zod/lib/types.d.ts:868

Class ZodBranded<T, B>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ZodBranded<T, B>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

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

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

Returns ParseContext

_getType

Parameters

Returns string

_parse

Parameters

Returns ParseReturnType<any>

_parseAsync

Parameters

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

_parseSync

Parameters

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

_processInputParams

Parameters

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

Parameters

Returns any

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

and

Type Parameters

Parameters

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

array

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

brand

Type Parameters

Parameters

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

catch

Parameters

Returns ZodCatch<ZodBranded<T, B>>

Parameters

Parameters

error: ZodError<any>

input: T["_input"]

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

Returns ZodCatch<ZodBranded<T, B>>

default

Parameters

Returns ZodDefault<ZodBranded<T, B>>

Parameters

Returns noUndefined<T["_input"]>

Returns ZodDefault<ZodBranded<T, B>>

describe

Parameters

Returns this

isNullable

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

Returns {
ctx: ParseContext;
status: ParseStatus;
}