Skip to main content
Module

x/zod/mod.ts>z.ZodSchema#refine

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

Type Parameters

RefinedOutput extends Output

Parameters

check: (arg: Output) => arg is RefinedOutput
optional
message: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)

Parameters

check: (arg: Output) => unknown | Promise<unknown>
optional
message: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)

Returns

ZodEffects<this, Output, Input>