Skip to main content
Module

x/zod/mod.ts>z.ZodSchema

TypeScript-first schema validation with static type inference
Extremely Popular
Go to Latest
class z.ZodSchema
Abstract
import { z } from "https://deno.land/x/zod@v3.21.4/mod.ts";
const { ZodSchema } = z;

Constructors

new
ZodSchema(def: Def)

Type Parameters

optional
Output = any
optional
Def extends ZodTypeDef = ZodTypeDef
optional
Input = Output

Properties

readonly
_def: Def
readonly
_input: Input
readonly
_output: Output
readonly
_type: Output
readonly
description
spa

Alias of safeParseAsync

Methods

_getType(input: ParseInput): string
_refinement(refinement: RefinementEffect<Output>["refinement"]): ZodEffects<this, Output, Input>
and<T extends ZodTypeAny>(incoming: T): ZodIntersection<this, T>
array(): ZodArray<this>
brand<B extends string | number | symbol>(brand?: B): ZodBranded<this, B>
catch(def: Output): ZodCatch<this>
catch(def: (ctx: { error: ZodError; input: Input; }) => Output): ZodCatch<this>
describe(description: string): this
isNullable(): boolean
isOptional(): boolean
or<T extends ZodTypeAny>(option: T): ZodUnion<[this, T]>
parse(data: unknown, params?: Partial<ParseParams>): Output
parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<Output>
pipe<T extends ZodTypeAny>(target: T): ZodPipeline<this, T>
refine<RefinedOutput extends Output>(check: (arg: Output) => arg is RefinedOutput, message?: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)): ZodEffects<this, RefinedOutput, Input>
refine(check: (arg: Output) => unknown | Promise<unknown>, message?: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)): ZodEffects<this, Output, Input>
refinement<RefinedOutput extends Output>(check: (arg: Output) => arg is RefinedOutput, refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<this, RefinedOutput, Input>
refinement(check: (arg: Output) => boolean, refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<this, Output, Input>
safeParse(data: unknown, params?: Partial<ParseParams>): SafeParseReturnType<Input, Output>
safeParseAsync(data: unknown, params?: Partial<ParseParams>): Promise<SafeParseReturnType<Input, Output>>
superRefine<RefinedOutput extends Output>(refinement: (arg: Output, ctx: RefinementCtx) => arg is RefinedOutput): ZodEffects<this, RefinedOutput, Input>
superRefine(refinement: (arg: Output, ctx: RefinementCtx) => void): ZodEffects<this, Output, Input>
transform<NewOut>(transform: (arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>): ZodEffects<this, NewOut>