ZodType | /types.ts | zod@v3.23.0

Module

x/zod/types.ts>ZodType#refine

TypeScript-first schema validation with static type inference

colinhacks/zod

Extremely Popular

Go to Latest

benchmarks helpers locales

index.ts (default module)

ZodDiscriminatedUnion

ZodDiscriminatedUnionDef

OutputTypeOfTupleWithRest

PassthroughType

ProcessedCreateParams

ZodDiscriminatedUnionOption

ZodDiscriminatedUnion

ZodDiscriminatedUnionDef

ZodInvalidArgumentsIssue

ZodInvalidDateIssue

ZodInvalidEnumValueIssue

ZodInvalidIntersectionTypesIssue

ZodInvalidLiteralIssue

ZodInvalidReturnTypeIssue

ZodInvalidStringIssue

ZodInvalidTypeIssue

ZodInvalidUnionDiscriminatorIssue

ZodNotMultipleOfIssue

ZodUnrecognizedKeysIssue

InputTypeOfTupleWithRest

OutputTypeOfTupleWithRest

ProcessedCreateParams

ZodDiscriminatedUnionOption

ZodErrorMap

ZodFirstPartySchemaTypes

ZodIssueOptionalMessage

any

map

nan

set

ZodFirstPartyTypeKind

method ZodType.prototype.refine

import { ZodType } from "https://deno.land/x/zod@v3.23.0/types.ts";

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>

Type Parameters

RefinedOutput extends Output

Parameters

check: (arg: Output) => arg is RefinedOutput

optional

message: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)

Returns

ZodEffects<this, RefinedOutput, Input>

Parameters

check: (arg: Output) => unknown | Promise<unknown>

optional

message: string | CustomErrorParams | ((arg: Output) => CustomErrorParams)

Returns

ZodEffects<this, Output, Input>