Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/zod/index.ts>z.ZodSchema#refinement

TypeScript-first schema validation with static type inference
Extremely Popular
Go to Latest
method z.ZodSchema.prototype.refinement
import { z } from "https://deno.land/x/zod@v3.23.0-beta.0/index.ts";
const { ZodSchema } = z;

Type Parameters

RefinedOutput extends Output

Parameters

check: (arg: Output) => arg is RefinedOutput
refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)

Parameters

check: (arg: Output) => boolean
refinementData: IssueData | ((arg: Output, ctx: RefinementCtx) => IssueData)

Returns

ZodEffects<this, Output, Input>