Skip to main content
Module

x/zod/types.ts>Schema

TypeScript-first schema validation with static type inference
colinhacks/zod
Extremely Popular
Go to Latest
class Schema
Abstract
import { Schema } from "https://deno.land/x/zod@v3.17.3/types.ts";

Constructors

new
Schema(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

superRefine

Methods

_getOrReturnCtx(input: ParseInput, ctx?: ParseContext | undefined): ParseContext
_getType(input: ParseInput): string
abstract
_parse(input: ParseInput): ParseReturnType<Output>
_parseAsync(input: ParseInput): AsyncParseReturnType<Output>
_parseSync(input: ParseInput): SyncParseReturnType<Output>
_processInputParams(input: ParseInput): { status: ParseStatus; ctx: ParseContext; }
_refinement(refinement: RefinementEffect<Output>["refinement"]): ZodEffects<this, Output, Input>
and<T extends ZodTypeAny>(incoming: T): ZodIntersection<this, T>
array(): ZodArray<this>
default(def: util.noUndefined<Input>): ZodDefault<this>
default(def: () => util.noUndefined<Input>): ZodDefault<this>
default(def: any)
describe(description: string): this
isNullable(): boolean
isOptional(): boolean
nullable(): ZodNullable<this>
nullish(): ZodNullable<ZodOptional<this>>
optional(): ZodOptional<this>
or<T extends ZodTypeAny>(option: T): ZodUnion<[this, T]>
parse(data: unknown, params?: Partial<ParseParams>): Output
parseAsync(data: unknown, params?: Partial<ParseParams>): Promise<Output>
promise(): ZodPromise<this>
refine<RefinedOutput extends Output>(check: (arg: Output) => arg is RefinedOutput, message?: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)): ZodEffects<this, RefinedOutput, RefinedOutput>
refine(check: (arg: Output) => unknown | Promise<unknown>, message?: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)): ZodEffects<this, Output, Input>
refine(check: (arg: Output) => 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, RefinedOutput>
refinement(check: (arg: Output) => boolean, refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)): ZodEffects<this, Output, Input>
refinement(check: (arg: Output) => unknown, 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>>
transform<NewOut>(transform: (arg: Output, ctx: RefinementCtx) => NewOut | Promise<NewOut>): ZodEffects<this, NewOut>