import { z } from "https://deno.land/x/zod@v3.22.0/mod.ts";
const { ZodType } = z;
Parameters
check: (arg: Output) => arg is RefinedOutput
Returns
ZodEffects<this, RefinedOutput, Input>
Module
x/zod/mod.ts>z.ZodType#refinement
TypeScript-first schema validation with static type inference
Extremely Popular
benchmarkshelperslocalesobjectUtilutilzParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodReadonlyZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodReadonlyDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCatchallInputCatchallOutputCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIpVersionIssueDataKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePassthroughTypePreprocessEffectPrimitiveProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffecttypecastTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodBigIntCheckZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilutilParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodReadonlyZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodReadonlyDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCatchallInputCatchallOutputCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIpVersionIssueDataKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePassthroughTypePreprocessEffectPrimitiveProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffecttypecastTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodBigIntCheckZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilutilzParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodReadonlyZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodReadonlyDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCatchallInputCatchallOutputCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIpVersionIssueDataKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePassthroughTypePreprocessEffectPrimitiveProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffecttypecastTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodBigIntCheckZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodReadonlyZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodReadonlyDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArraybaseObjectInputTypebaseObjectOutputTypeBRANDCatchallInputCatchallOutputCustomErrorParamsdeoptionalEffectEnumLikeEnumValuesFilterEnumIndicesinferInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestIpVersionKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectOutputTypeOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestPassthroughTypePreprocessEffectProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessSomeZodObjectSuperRefinementTransformEffecttypecastTypeOfUnknownKeysParamValuesWriteableZodBigIntCheckZodDateCheckZodDiscriminatedUnionOptionZodFirstPartySchemaTypesZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatediscriminatedUnioneffectenumfunctioninstanceofintersectionlatelazyliteralmapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromiserecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidZodFirstPartyTypeKindZodErrorZodCustomIssueZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodNotFiniteIssueZodNotMultipleOfIssueZodTooBigIssueZodTooSmallIssueZodUnrecognizedKeysIssueDenormalizedErrorErrorMapCtxinferFlattenedErrorsinferFormattedErrorIssueDataStringValidationtypeToFlattenedErrorZodErrorMapZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessagequotelessJson
mod.ts (default module)
N
N
N
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
v
T
T
T
T
T
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
f
f
f
E
external.ts
N
N
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
v
T
T
T
T
T
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
f
f
f
E
index.ts
N
N
N
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
v
T
T
T
T
T
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
f
f
f
E
types.ts
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
v
E
ZodError.ts
c
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
I
T
T
T
T
T
T
T
T
T
T
T
T
v
T
v