Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as zod from "https://esm.sh/zod@3.25.76/index.d.cts";

§Namespaces

objectUtil
util
z
z.objectUtil
z.util

§Classes

ParseStatus
Schema abstract
z.ParseStatus
z.Schema abstract
z.ZodAny
z.ZodArray
z.ZodBigInt
z.ZodBoolean
z.ZodBranded
z.ZodCatch
z.ZodDate
z.ZodDefault
z.ZodDiscriminatedUnion
z.ZodEffects
z.ZodEnum
z.ZodError
z.ZodFunction
z.ZodIntersection
z.ZodLazy
z.ZodLiteral
z.ZodMap
z.ZodNaN
z.ZodNativeEnum
z.ZodNever
z.ZodNull
z.ZodNullable
z.ZodNumber
z.ZodObject
z.ZodOptional
z.ZodPipeline
z.ZodPromise
z.ZodReadonly
z.ZodRecord
z.ZodSchema abstract
z.ZodSet
z.ZodString
z.ZodSymbol
z.ZodTransformer
z.ZodTuple
z.ZodType abstract
z.ZodUndefined
z.ZodUnion
z.ZodUnknown
z.ZodVoid
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
ZodSchema abstract
ZodSet
ZodString
ZodSymbol
ZodTransformer
ZodTuple
ZodType abstract
ZodUndefined
ZodUnion
ZodUnknown
ZodVoid

§Enums

z.ZodFirstPartyTypeKind
ZodFirstPartyTypeKind

§Variables

any
array
bigint
boolean
BRAND
coerce
date
defaultErrorMap
DIRTY
discriminatedUnion
effect
EMPTY_PATH
enum
function
getParsedType
instanceof
intersection
INVALID
isAborted
isAsync
isDirty
isValid
late
lazy
literal
makeIssue
map
nan
nativeEnum
never
NEVER
null
nullable
number
object
objectUtil.mergeShapes
oboolean
OK
onumber
optional
ostring
pipeline
preprocess
promise
quotelessJson
record
set
strictObject
string
symbol
transformer
tuple
undefined
union
unknown
util.arrayToEnum
util.assertEqual
util.find
util.getValidEnumValues
util.isInteger
util.jsonStringifyReplacer
util.objectKeys
util.objectValues
void
z.any
z.array
z.bigint
z.boolean
z.BRAND
z.coerce
z.date
z.defaultErrorMap
z.DIRTY
z.discriminatedUnion
z.effect
z.EMPTY_PATH
z.enum
z.function
z.getParsedType
z.instanceof
z.intersection
z.INVALID
z.isAborted
z.isAsync
z.isDirty
z.isValid
z.late
z.lazy
z.literal
z.makeIssue
z.map
z.nan
z.nativeEnum
z.never
z.NEVER
z.null
z.nullable
z.number
z.object
z.objectUtil.mergeShapes
z.oboolean
z.OK
z.onumber
z.optional
z.ostring
z.pipeline
z.preprocess
z.promise
z.quotelessJson
z.record
z.set
z.strictObject
z.string
z.symbol
z.transformer
z.tuple
z.undefined
z.union
z.unknown
z.util.arrayToEnum
z.util.assertEqual
z.util.find
z.util.getValidEnumValues
z.util.isInteger
z.util.jsonStringifyReplacer
z.util.objectKeys
z.util.objectValues
z.void
z.ZodIssueCode
z.ZodParsedType
ZodIssueCode
ZodParsedType

§Functions

addIssueToContext
custom
datetimeRegex
getErrorMap
setErrorMap
util.assertIs
util.assertNever
util.joinValues
z.addIssueToContext
z.custom
z.datetimeRegex
z.getErrorMap
z.setErrorMap
z.util.assertIs
z.util.assertNever
z.util.joinValues

§Interfaces

ParseContext
ParseResult
RefinementCtx
z.ParseContext
z.ParseResult
z.RefinementCtx
z.ZodAnyDef
z.ZodArrayDef
z.ZodBigIntDef
z.ZodBooleanDef
z.ZodBrandedDef
z.ZodCatchDef
z.ZodCustomIssue
z.ZodDateDef
z.ZodDefaultDef
z.ZodDiscriminatedUnionDef
z.ZodEffectsDef
z.ZodEnumDef
z.ZodFunctionDef
z.ZodIntersectionDef
z.ZodInvalidArgumentsIssue
z.ZodInvalidDateIssue
z.ZodInvalidEnumValueIssue
z.ZodInvalidIntersectionTypesIssue
z.ZodInvalidLiteralIssue
z.ZodInvalidReturnTypeIssue
z.ZodInvalidStringIssue
z.ZodInvalidTypeIssue
z.ZodInvalidUnionDiscriminatorIssue
z.ZodInvalidUnionIssue
z.ZodLazyDef
z.ZodLiteralDef
z.ZodMapDef
z.ZodNaNDef
z.ZodNativeEnumDef
z.ZodNeverDef
z.ZodNotFiniteIssue
z.ZodNotMultipleOfIssue
z.ZodNullableDef
z.ZodNullDef
z.ZodNumberDef
z.ZodObjectDef
z.ZodOptionalDef
z.ZodPipelineDef
z.ZodPromiseDef
z.ZodReadonlyDef
z.ZodRecordDef
z.ZodSetDef
z.ZodStringDef
z.ZodSymbolDef
z.ZodTooBigIssue
z.ZodTooSmallIssue
z.ZodTupleDef
z.ZodTypeDef
z.ZodUndefinedDef
z.ZodUnionDef
z.ZodUnknownDef
z.ZodUnrecognizedKeysIssue
z.ZodVoidDef
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
infer
inferFlattenedErrors
inferFormattedError
InnerTypeOfFunction
input
InputTypeOfTuple
InputTypeOfTupleWithRest
INVALID
IpVersion
IssueData
KeySchema
mergeTypes
noUnrecognized
objectInputType
objectOutputType
ObjectPair
objectUtil.addQuestionMarks
objectUtil.extendShape
objectUtil.flatten
objectUtil.identity
objectUtil.MergeShapes
objectUtil.noNever
objectUtil.noNeverKeys
OK
OuterTypeOfFunction
output
OutputTypeOfTuple
OutputTypeOfTupleWithRest
ParseInput
ParseParams
ParsePath
ParsePathComponent
ParseReturnType
PassthroughType
PreprocessEffect
Primitive
ProcessedCreateParams
RawCreateParams
RecordType
Refinement
RefinementEffect
SafeParseError
SafeParseReturnType
SafeParseSuccess
Scalars
SomeZodObject
StringValidation
SuperRefinement
SyncParseReturnType
TransformEffect
typecast
TypeOf
typeToFlattenedError
UnknownKeysParam
util.Exactly
util.flatten
util.identity
util.InexactPartial
util.isAny
util.MakePartial
util.noUndefined
util.Omit
util.OmitKeys
Values
Writeable
z.AnyZodObject
z.AnyZodTuple
z.ArrayCardinality
z.ArrayKeys
z.arrayOutputType
z.AssertArray
z.AsyncParseReturnType
z.baseObjectInputType
z.baseObjectOutputType
z.BRAND
z.CatchallInput
z.CatchallOutput
z.CustomErrorParams
z.DenormalizedError
z.deoptional
z.DIRTY
z.Effect
z.EnumLike
z.EnumValues
z.ErrorMapCtx
z.FilterEnum
z.Indices
z.infer
z.inferFlattenedErrors
z.inferFormattedError
z.InnerTypeOfFunction
z.input
z.InputTypeOfTuple
z.InputTypeOfTupleWithRest
z.INVALID
z.IpVersion
z.IssueData
z.KeySchema
z.mergeTypes
z.noUnrecognized
z.objectInputType
z.objectOutputType
z.ObjectPair
z.objectUtil.addQuestionMarks
z.objectUtil.extendShape
z.objectUtil.flatten
z.objectUtil.identity
z.objectUtil.MergeShapes
z.objectUtil.noNever
z.objectUtil.noNeverKeys
z.OK
z.OuterTypeOfFunction
z.output
z.OutputTypeOfTuple
z.OutputTypeOfTupleWithRest
z.ParseInput
z.ParseParams
z.ParsePath
z.ParsePathComponent
z.ParseReturnType
z.PassthroughType
z.PreprocessEffect
z.Primitive
z.ProcessedCreateParams
z.RawCreateParams
z.RecordType
z.Refinement
z.RefinementEffect
z.SafeParseError
z.SafeParseReturnType
z.SafeParseSuccess
z.Scalars
z.SomeZodObject
z.StringValidation
z.SuperRefinement
z.SyncParseReturnType
z.TransformEffect
z.typecast
z.TypeOf
z.typeToFlattenedError
z.UnknownKeysParam
z.util.Exactly
z.util.flatten
z.util.identity
z.util.InexactPartial
z.util.isAny
z.util.MakePartial
z.util.noUndefined
z.util.Omit
z.util.OmitKeys
z.Values
z.Writeable
z.ZodBigIntCheck
z.ZodDateCheck
z.ZodDiscriminatedUnionOption
z.ZodErrorMap
z.ZodFirstPartySchemaTypes
z.ZodFormattedError
z.ZodIssue
z.ZodIssueBase
z.ZodIssueCode
z.ZodIssueOptionalMessage
z.ZodNonEmptyArray
z.ZodNullableType
z.ZodNumberCheck
z.ZodOptionalType
z.ZodParsedType
z.ZodRawShape
z.ZodStringCheck
z.ZodTupleItems
z.ZodTypeAny
z.ZodUnionOptions
ZodBigIntCheck
ZodDateCheck
ZodDiscriminatedUnionOption
ZodErrorMap
ZodFirstPartySchemaTypes
ZodFormattedError
ZodIssue
ZodIssueBase
ZodIssueCode
ZodIssueOptionalMessage
ZodNonEmptyArray
ZodNullableType
ZodNumberCheck
ZodOptionalType
ZodParsedType
ZodRawShape
ZodStringCheck
ZodTupleItems
ZodTypeAny
ZodUnionOptions