import { z } from "https://deno.land/x/zod@v3.20.3/index.ts";
const { Schema } = z;
Parameters
refinement: RefinementEffect<Output>["refinement"]
Returns
ZodEffects<this, Output, Input>
Module
x/zod/index.ts>z.Schema#_refinement
TypeScript-first schema validation with static type inference
Extremely Popular
benchmarkshelperslocalesobjectUtilutilzParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxextendShapeFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIssueDataKeySchemanoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePreprocessEffectPrimitiveProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffectTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilutilParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxextendShapeFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIssueDataKeySchemanoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePreprocessEffectPrimitiveProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffectTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilutilzParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxextendShapeFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIssueDataKeySchemanoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePreprocessEffectPrimitiveProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffectTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArraybaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsdeoptionalEffectEnumLikeEnumValuesextendShapeFilterEnumIndicesinferInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestKeySchemanoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestPreprocessEffectProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessSomeZodObjectSuperRefinementTransformEffectTypeOfUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodFirstPartySchemaTypesZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatediscriminatedUnioneffectenumfunctioninstanceofintersectionlatelazyliteralmapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromiserecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidZodFirstPartyTypeKindZodErrorZodCustomIssueZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodNotFiniteIssueZodNotMultipleOfIssueZodTooBigIssueZodTooSmallIssueZodUnrecognizedKeysIssueDenormalizedErrorErrorMapCtxinferFlattenedErrorsinferFormattedErrorIssueDataStringValidationtypeToFlattenedErrorZodErrorMapZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessagequotelessJson
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
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
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
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
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
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
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
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
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
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
v
T
T
T
T
T
T
T
T
T
T
T
T
T
T
T
v
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
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
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
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
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