Class ZodType<Output, Def, Input>`Abstract`

Type Parameters

Output = any
Def extends ZodTypeDef = ZodTypeDef
Input = Output

Hierarchy

ZodType
- ZodEnum
- ZodObject
- ZodString
- ZodLiteral
- ZodArray
- ZodEffects
- ZodOptional
- ZodNullable
- ZodPromise
- ZodUnion
- ZodIntersection
- ZodDefault
- ZodBranded
- ZodCatch
- ZodPipeline
- ZodTuple

Index

Constructors

constructor

new ZodType<Output, Def, Input>(def: Def): ZodType<Output, Def, Input>
Type Parameters
- Output = any
- Def extends ZodTypeDef = ZodTypeDef
- Input = Output
Parameters
- def: Def
Returns ZodType<Output, Def, Input>
- Defined in node_modules/zod/lib/types.d.ts:72

Properties

`Readonly` _def

_def: Def

`Readonly` _input

_input: Input

`Readonly` _output

_output: Output

`Readonly` _type

_type: Output

spa

spa: ((data: unknown, params?: Partial<ParseParams>) => Promise<SafeParseReturnType<Input, Output>>)

Type declaration

- (data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Input, Output>>
- Alias of safeParseAsync
  Parameters
  - data: unknown
  - Optional params: Partial<ParseParams>
  Returns Promise<SafeParseReturnType<Input, Output>>

Accessors

description

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

Methods

_getOrReturnCtx

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

_getType

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

`Abstract` _parse

_parse(input: ParseInput): ParseReturnType<Output>
Parameters
- input: ParseInput
Returns ParseReturnType<Output>
- Defined in node_modules/zod/lib/types.d.ts:50

_parseAsync

_parseAsync(input: ParseInput): AsyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns AsyncParseReturnType<Output>
- Defined in node_modules/zod/lib/types.d.ts:58

_parseSync

_parseSync(input: ParseInput): SyncParseReturnType<Output>
Parameters
- input: ParseInput
Returns SyncParseReturnType<Output>
- Defined in 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
- Defined in node_modules/zod/lib/types.d.ts:53

_refinement

_refinement(refinement: ((arg: Output, ctx: RefinementCtx) => any)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => any)
  - - (arg: Output, ctx: RefinementCtx): any
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns any
Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>
- Defined in node_modules/zod/lib/types.d.ts:69

and

and<T>(incoming: T): ZodIntersection<ZodType<Output, Def, Input>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- incoming: T
Returns ZodIntersection<ZodType<Output, Def, Input>, T>
- Defined in node_modules/zod/lib/types.d.ts:79

array

array(): ZodArray<ZodType<Output, Def, Input>, "many">
Returns ZodArray<ZodType<Output, Def, Input>, "many">
- Defined in node_modules/zod/lib/types.d.ts:76

brand

brand<B>(brand?: B): ZodBranded<ZodType<Output, Def, Input>, B>
Type Parameters
- B extends string | number | symbol
Parameters
- Optional brand: B
Returns ZodBranded<ZodType<Output, Def, Input>, B>
- Defined in node_modules/zod/lib/types.d.ts:83

catch

catch(def: Input): ZodCatch<ZodType<Output, Def, Input>>
Parameters
- def: Input
Returns ZodCatch<ZodType<Output, Def, Input>>
- Defined in node_modules/zod/lib/types.d.ts:84
catch(def: (() => Input)): ZodCatch<ZodType<Output, Def, Input>>
Parameters
- def: (() => Input)
  - - (): Input
    - Returns Input
Returns ZodCatch<ZodType<Output, Def, Input>>
- Defined in node_modules/zod/lib/types.d.ts:85

default

default(def: noUndefined<Input>): ZodDefault<ZodType<Output, Def, Input>>
Parameters
- def: noUndefined<Input>
Returns ZodDefault<ZodType<Output, Def, Input>>
- Defined in node_modules/zod/lib/types.d.ts:81
default(def: (() => noUndefined<Input>)): ZodDefault<ZodType<Output, Def, Input>>
Parameters
- def: (() => noUndefined<Input>)
  - - (): noUndefined<Input>
    - Returns noUndefined<Input>
Returns ZodDefault<ZodType<Output, Def, Input>>
- Defined in node_modules/zod/lib/types.d.ts:82

describe

describe(description: string): ZodType<Output, Def, Input>
Parameters
- description: string
Returns ZodType<Output, Def, Input>
- Defined in node_modules/zod/lib/types.d.ts:86

isNullable

isNullable(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:89

isOptional

isOptional(): boolean
Returns boolean
- Defined in node_modules/zod/lib/types.d.ts:88

nullable

nullable(): ZodNullable<ZodType<Output, Def, Input>>
Returns ZodNullable<ZodType<Output, Def, Input>>
- Defined in node_modules/zod/lib/types.d.ts:74

nullish

nullish(): ZodNullable<ZodOptional<ZodType<Output, Def, Input>>>
Returns ZodNullable<ZodOptional<ZodType<Output, Def, Input>>>
- Defined in node_modules/zod/lib/types.d.ts:75

optional

optional(): ZodOptional<ZodType<Output, Def, Input>>
Returns ZodOptional<ZodType<Output, Def, Input>>
- Defined in node_modules/zod/lib/types.d.ts:73

or

or<T>(option: T): ZodUnion<[ZodType<Output, Def, Input>, T]>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- option: T
Returns ZodUnion<[ZodType<Output, Def, Input>, T]>
- Defined in node_modules/zod/lib/types.d.ts:78

parse

parse(data: unknown, params?: Partial<ParseParams>): Output
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Output
- Defined in node_modules/zod/lib/types.d.ts:59

parseAsync

parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<Output>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<Output>
- Defined in node_modules/zod/lib/types.d.ts:61

pipe

pipe<T>(target: T): ZodPipeline<ZodType<Output, Def, Input>, T>
Type Parameters
- T extends ZodType<any, any, any, T>
Parameters
- target: T
Returns ZodPipeline<ZodType<Output, Def, Input>, T>
- Defined in node_modules/zod/lib/types.d.ts:87

promise

promise(): ZodPromise<ZodType<Output, Def, Input>>
Returns ZodPromise<ZodType<Output, Def, Input>>
- Defined in node_modules/zod/lib/types.d.ts:77

refine

refine<RefinedOutput>(check: ((arg: Output) => arg is RefinedOutput), message?: string | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>) | Partial<Omit<ZodCustomIssue, "code">>): ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg: Output) => arg is RefinedOutput)
  - - (arg: Output): arg is RefinedOutput
    - Parameters
      
      arg: Output
      
      Returns arg is RefinedOutput
- Optional message: string | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>) | Partial<Omit<ZodCustomIssue, "code">>
Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>
- Defined in node_modules/zod/lib/types.d.ts:65
refine(check: ((arg: Output) => unknown), message?: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>
Parameters
- check: ((arg: Output) => unknown)
  - - (arg: Output): unknown
    - Parameters
      
      arg: Output
      
      Returns unknown
- Optional message: string | Partial<Omit<ZodCustomIssue, "code">> | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>)
Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>
- Defined in node_modules/zod/lib/types.d.ts:66

refinement

refinement<RefinedOutput>(check: ((arg: Output) => arg is RefinedOutput), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- check: ((arg: Output) => arg is RefinedOutput)
  - - (arg: Output): arg is RefinedOutput
    - Parameters
      
      arg: Output
      
      Returns arg is RefinedOutput
- refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>
- Defined in node_modules/zod/lib/types.d.ts:67
refinement(check: ((arg: Output) => boolean), refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>
Parameters
- check: ((arg: Output) => boolean)
  - - (arg: Output): boolean
    - Parameters
      
      arg: Output
      
      Returns boolean
- refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)
Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>
- Defined in node_modules/zod/lib/types.d.ts:68

safeParse

safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<Input, Output>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns SafeParseReturnType<Input, Output>
- Defined in node_modules/zod/lib/types.d.ts:60

safeParseAsync

safeParseAsync(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Input, Output>>
Parameters
- data: unknown
- Optional params: Partial<ParseParams>
Returns Promise<SafeParseReturnType<Input, Output>>
- Defined in node_modules/zod/lib/types.d.ts:62

superRefine

superRefine<RefinedOutput>(refinement: ((arg: Output, ctx: RefinementCtx) => arg is RefinedOutput)): ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>
Type Parameters
- RefinedOutput
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => arg is RefinedOutput)
  - - (arg: Output, ctx: RefinementCtx): arg is RefinedOutput
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns arg is RefinedOutput
Returns ZodEffects<ZodType<Output, Def, Input>, RefinedOutput, Input>
- Defined in node_modules/zod/lib/types.d.ts:70
superRefine(refinement: ((arg: Output, ctx: RefinementCtx) => void)): ZodEffects<ZodType<Output, Def, Input>, Output, Input>
Parameters
- refinement: ((arg: Output, ctx: RefinementCtx) => void)
  - - (arg: Output, ctx: RefinementCtx): void
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns void
Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>
- Defined in node_modules/zod/lib/types.d.ts:71

transform

transform<NewOut>(transform: ((arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>)): ZodEffects<ZodType<Output, Def, Input>, NewOut, Input>
Type Parameters
- NewOut
Parameters
- transform: ((arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>)
  - - (arg: Output, ctx: RefinementCtx): NewOut | Promise<NewOut>
    - Parameters
      
      arg: Output
      
      ctx: RefinementCtx
      
      Returns NewOut | Promise<NewOut>
Returns ZodEffects<ZodType<Output, Def, Input>, NewOut, Input>
- Defined in node_modules/zod/lib/types.d.ts:80

Class ZodType<Output, Def, Input>Abstract

Type Parameters

Output = any

Def extends ZodTypeDef = ZodTypeDef

Input = Output

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Output = any

Def extends ZodTypeDef = ZodTypeDef

Input = Output

Parameters

def: Def

Returns ZodType<Output, Def, Input>

Properties

Readonly _def

Readonly _input

Readonly _output

Readonly _type

spa

Type declaration

Parameters

data: unknown

Optional params: Partial<ParseParams>

Returns Promise<SafeParseReturnType<Input, Output>>

Accessors

description

Returns undefined | string

Methods

_getOrReturnCtx

Parameters

input: ParseInput

Optional ctx: ParseContext

Returns ParseContext

_getType

Parameters

input: ParseInput

Returns string

Abstract _parse

Parameters

input: ParseInput

Returns ParseReturnType<Output>

_parseAsync

Parameters

input: ParseInput

Returns AsyncParseReturnType<Output>

_parseSync

Parameters

input: ParseInput

Returns SyncParseReturnType<Output>

_processInputParams

Parameters

input: ParseInput

Returns { ctx: ParseContext; status: ParseStatus; }

ctx: ParseContext

status: ParseStatus

_refinement

Parameters

refinement: ((arg: Output, ctx: RefinementCtx) => any)

Parameters

arg: Output

ctx: RefinementCtx

Returns any

Returns ZodEffects<ZodType<Output, Def, Input>, Output, Input>

and

Type Parameters

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

Parameters

incoming: T

Returns ZodIntersection<ZodType<Output, Def, Input>, T>

array

Returns ZodArray<ZodType<Output, Def, Input>, "many">

brand

Type Parameters

Class ZodType<Output, Def, Input>`Abstract`

`Readonly` _def

`Readonly` _input

`Readonly` _output

`Readonly` _type

`Optional` params: Partial<ParseParams>

`Optional` ctx: ParseContext

`Abstract` _parse

Returns {
ctx: ParseContext;
status: ParseStatus;
}

`Optional` brand: B

`Optional` params: Partial<ParseParams>

`Optional` params: Partial<ParseParams>

`Optional` message: string | ((arg: Output) => Partial<Omit<ZodCustomIssue, "code">>) | Partial<Omit<ZodCustomIssue, "code">>