interface z.ZodBrandedDef
implements ZodTypeDef
import { type z } from "https://deno.land/x/zod@v3.20.5/index.ts";
const { ZodBrandedDef } = z;
Type Parameters
T extends ZodTypeAny
Properties
type: T
Extremely Popular
benchmarkshelperslocalesobjectUtilutilzParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxextendShapeFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIssueDataKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePreprocessEffectPrimitiveProcessedCreateParamsprocessTypeRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffecttypecastTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilutilParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxextendShapeFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIssueDataKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePreprocessEffectPrimitiveProcessedCreateParamsprocessTypeRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffecttypecastTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilutilzParseStatusSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodErrorZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxextendShapeFilterEnumIndicesinferinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIssueDataKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePreprocessEffectPrimitiveProcessedCreateParamsprocessTypeRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffecttypecastTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatedefaultErrorMapdiscriminatedUnioneffectEMPTY_PATHenumfunctiongetParsedTypeinstanceofintersectionisAbortedisAsyncisDirtyisValidlatelazyliteralmakeIssuemapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromisequotelessJsonrecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidaddIssueToContextgetErrorMapsetErrorMapZodFirstPartyTypeKindobjectUtilSchemaZodAnyZodArrayZodBigIntZodBooleanZodBrandedZodCatchZodDateZodDefaultZodDiscriminatedUnionZodEffectsZodEnumZodFunctionZodIntersectionZodLazyZodLiteralZodMapZodNaNZodNativeEnumZodNeverZodNullZodNullableZodNumberZodObjectZodOptionalZodPipelineZodPromiseZodRecordZodSchemaZodSetZodStringZodSymbolZodTransformerZodTupleZodTypeZodUndefinedZodUnionZodUnknownZodVoidZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodVoidDefAnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArraybaseObjectInputTypebaseObjectOutputTypeBRANDCustomErrorParamsdeoptionalEffectEnumLikeEnumValuesextendShapeFilterEnumIndicesinferInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectKeyMaskobjectOutputTypeOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestPreprocessEffectProcessedCreateParamsprocessTypeRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessSomeZodObjectSuperRefinementTransformEffecttypecastTypeOfUnknownKeysParamValuesWriteableZodDateCheckZodDiscriminatedUnionOptionZodFirstPartySchemaTypesZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptionsanyarraybigintbooleancoercecustomdatediscriminatedUnioneffectenumfunctioninstanceofintersectionlatelazyliteralmapnannativeEnumneverNEVERnullnullablenumberobjectobooleanonumberoptionalostringpipelinepreprocesspromiserecordsetstrictObjectstringsymboltransformertupleundefinedunionunknownvoidZodFirstPartyTypeKindZodErrorZodCustomIssueZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodNotFiniteIssueZodNotMultipleOfIssueZodTooBigIssueZodTooSmallIssueZodUnrecognizedKeysIssueDenormalizedErrorErrorMapCtxinferFlattenedErrorsinferFormattedErrorIssueDataStringValidationtypeToFlattenedErrorZodErrorMapZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessagequotelessJson
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
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
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
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
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
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
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
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