Namespace z

Namespaces

objectUtil
util

Enumerations

ZodFirstPartyTypeKind

Classes

ParseStatus
ZodAny
ZodArray
ZodBigInt
ZodBoolean
ZodBranded
ZodCatch
ZodDate
ZodDefault
ZodDiscriminatedUnion
ZodEffects
ZodEnum
ZodError
ZodFunction
ZodIntersection
ZodLazy
ZodLiteral
ZodMap
ZodNaN
ZodNativeEnum
ZodNever
ZodNull
ZodNullable
ZodNumber
ZodObject
ZodOptional
ZodPipeline
ZodPromise
ZodReadonly
ZodRecord
ZodSet
ZodString
ZodSymbol
ZodTuple
ZodType
ZodUndefined
ZodUnion
ZodUnknown
ZodVoid

Interfaces

ParseContext
ParseResult
ZodAnyDef
ZodArrayDef
ZodBigIntDef
ZodBooleanDef
ZodBrandedDef
ZodCatchDef
ZodCustomIssue
ZodDateDef
ZodDefaultDef
ZodDiscriminatedUnionDef
ZodEffectsDef
ZodEnumDef
ZodFunctionDef
ZodIntersectionDef
ZodInvalidArgumentsIssue
ZodInvalidDateIssue
ZodInvalidEnumValueIssue
ZodInvalidIntersectionTypesIssue
ZodInvalidLiteralIssue
ZodInvalidReturnTypeIssue
ZodInvalidStringIssue
ZodInvalidTypeIssue
ZodInvalidUnionDiscriminatorIssue
ZodInvalidUnionIssue
ZodLazyDef
ZodLiteralDef
ZodMapDef
ZodNaNDef
ZodNativeEnumDef
ZodNeverDef
ZodNotFiniteIssue
ZodNotMultipleOfIssue
ZodNullableDef
ZodNullDef
ZodNumberDef
ZodObjectDef
ZodOptionalDef
ZodPipelineDef
ZodPromiseDef
ZodReadonlyDef
ZodRecordDef
ZodSetDef
ZodStringDef
ZodSymbolDef
ZodTooBigIssue
ZodTooSmallIssue
ZodTupleDef
ZodTypeDef
ZodUndefinedDef
ZodUnionDef
ZodUnknownDef
ZodUnrecognizedKeysIssue
ZodVoidDef

Type Aliases

AnyZodObject
AnyZodTuple
ArrayCardinality
ArrayKeys
arrayOutputType
AssertArray
AsyncParseReturnType
baseObjectInputType
baseObjectOutputType
BRAND
CatchallInput
CatchallOutput
CustomErrorParams
DenormalizedError
deoptional
DIRTY
Effect
EnumLike
EnumValues
ErrorMapCtx
FilterEnum
Indices
inferFlattenedErrors
inferFormattedError
InnerTypeOfFunction
input
InputTypeOfTuple
InputTypeOfTupleWithRest
INVALID
IpVersion
IssueData
KeySchema
mergeTypes
noUnrecognized
objectInputType
objectOutputType
ObjectPair
OK
OuterTypeOfFunction
output
OutputTypeOfTuple
OutputTypeOfTupleWithRest
ParseInput
ParseParams
ParsePath
ParsePathComponent
ParseReturnType
PassthroughType
PreprocessEffect
Primitive
ProcessedCreateParams
RawCreateParams
RecordType
Refinement
RefinementCtx
RefinementEffect
SafeParseError
SafeParseReturnType
SafeParseSuccess
Scalars
SomeZodObject
StringValidation
SuperRefinement
SyncParseReturnType
TransformEffect
typecast
TypeOf
typeToFlattenedError
UnknownKeysParam
Values
Writeable
ZodBigIntCheck
ZodDateCheck
ZodDiscriminatedUnionOption
ZodErrorMap
ZodFirstPartySchemaTypes
ZodFormattedError
ZodIssue
ZodIssueBase
ZodIssueCode
ZodIssueOptionalMessage
ZodNonEmptyArray
ZodNullableType
ZodNumberCheck
ZodOptionalType
ZodParsedType
ZodRawShape
ZodStringCheck
ZodTupleItems
ZodTypeAny
ZodUnionOptions

Variables

BRAND
coerce
EMPTY_PATH
INVALID
late
NEVER
ZodIssueCode
ZodParsedType

Functions

addIssueToContext
any
array
bigint
boolean
custom
date
defaultErrorMap
DIRTY
discriminatedUnion
effect
enum
function
getErrorMap
getParsedType
instanceof
intersection
isAborted
isAsync
isDirty
isValid
lazy
literal
makeIssue
map
nan
nativeEnum
never
null
nullable
number
object
oboolean
OK
onumber
optional
ostring
pipeline
preprocess
promise
quotelessJson
record
set
setErrorMap
strictObject
string
symbol
tuple
undefined
union
unknown
void

References

infer → Zod.z.TypeOf
Schema → Zod.z.ZodType
transformer → Zod.z.effect
ZodSchema → Zod.z.ZodType
ZodTransformer → Zod.z.ZodEffects

Settings

Member Visibility

On This Page

Namespaces
Enumerations
Classes
Interfaces
ParseContextParseResultZodAnyDefZodArrayDefZodBigIntDefZodBooleanDefZodBrandedDefZodCatchDefZodCustomIssueZodDateDefZodDefaultDefZodDiscriminatedUnionDefZodEffectsDefZodEnumDefZodFunctionDefZodIntersectionDefZodInvalidArgumentsIssueZodInvalidDateIssueZodInvalidEnumValueIssueZodInvalidIntersectionTypesIssueZodInvalidLiteralIssueZodInvalidReturnTypeIssueZodInvalidStringIssueZodInvalidTypeIssueZodInvalidUnionDiscriminatorIssueZodInvalidUnionIssueZodLazyDefZodLiteralDefZodMapDefZodNaNDefZodNativeEnumDefZodNeverDefZodNotFiniteIssueZodNotMultipleOfIssueZodNullableDefZodNullDefZodNumberDefZodObjectDefZodOptionalDefZodPipelineDefZodPromiseDefZodReadonlyDefZodRecordDefZodSetDefZodStringDefZodSymbolDefZodTooBigIssueZodTooSmallIssueZodTupleDefZodTypeDefZodUndefinedDefZodUnionDefZodUnknownDefZodUnrecognizedKeysIssueZodVoidDef
Type Aliases
AnyZodObjectAnyZodTupleArrayCardinalityArrayKeysarrayOutputTypeAssertArrayAsyncParseReturnTypebaseObjectInputTypebaseObjectOutputTypeBRANDCatchallInputCatchallOutputCustomErrorParamsDenormalizedErrordeoptionalDIRTYEffectEnumLikeEnumValuesErrorMapCtxFilterEnumIndicesinferFlattenedErrorsinferFormattedErrorInnerTypeOfFunctioninputInputTypeOfTupleInputTypeOfTupleWithRestINVALIDIpVersionIssueDataKeySchemamergeTypesnoUnrecognizedobjectInputTypeobjectOutputTypeObjectPairOKOuterTypeOfFunctionoutputOutputTypeOfTupleOutputTypeOfTupleWithRestParseInputParseParamsParsePathParsePathComponentParseReturnTypePassthroughTypePreprocessEffectPrimitiveProcessedCreateParamsRawCreateParamsRecordTypeRefinementRefinementCtxRefinementEffectSafeParseErrorSafeParseReturnTypeSafeParseSuccessScalarsSomeZodObjectStringValidationSuperRefinementSyncParseReturnTypeTransformEffecttypecastTypeOftypeToFlattenedErrorUnknownKeysParamValuesWriteableZodBigIntCheckZodDateCheckZodDiscriminatedUnionOptionZodErrorMapZodFirstPartySchemaTypesZodFormattedErrorZodIssueZodIssueBaseZodIssueCodeZodIssueOptionalMessageZodNonEmptyArrayZodNullableTypeZodNumberCheckZodOptionalTypeZodParsedTypeZodRawShapeZodStringCheckZodTupleItemsZodTypeAnyZodUnionOptions
Variables
Functions
References