/mod.ts | zod@v3.17.3

Module

x/zod/mod.ts

TypeScript-first schema validation with static type inference

colinhacks/zod

Very Popular

Go to Latest

mod.ts (default module)

ZodDiscriminatedUnion

ZodDiscriminatedUnionDef

ZodInvalidArgumentsIssue

ZodInvalidDateIssue

ZodInvalidEnumValueIssue

ZodInvalidIntersectionTypesIssue

ZodInvalidLiteralIssue

ZodInvalidReturnTypeIssue

ZodInvalidStringIssue

ZodInvalidTypeIssue

ZodInvalidUnionDiscriminatorIssue

ZodNotMultipleOfIssue

ZodUnrecognizedKeysIssue

InputTypeOfTupleWithRest

OutputTypeOfTupleWithRest

ZodDiscriminatedUnionOption

ZodErrorMap

ZodFirstPartySchemaTypes

ZodIssueOptionalMessage

any

map

nan

set

ZodFirstPartyTypeKind

ZodDiscriminatedUnion

ZodDiscriminatedUnionDef

ZodInvalidArgumentsIssue

ZodInvalidDateIssue

ZodInvalidEnumValueIssue

ZodInvalidIntersectionTypesIssue

ZodInvalidLiteralIssue

ZodInvalidReturnTypeIssue

ZodInvalidStringIssue

ZodInvalidTypeIssue

ZodInvalidUnionDiscriminatorIssue

ZodNotMultipleOfIssue

ZodUnrecognizedKeysIssue

InputTypeOfTupleWithRest

OutputTypeOfTupleWithRest

ZodDiscriminatedUnionOption

ZodErrorMap

ZodFirstPartySchemaTypes

ZodIssueOptionalMessage

any

map

nan

set

ZodFirstPartyTypeKind

ZodDiscriminatedUnion

ZodDiscriminatedUnionDef

ZodInvalidArgumentsIssue

ZodInvalidDateIssue

ZodInvalidEnumValueIssue

ZodInvalidIntersectionTypesIssue

ZodInvalidLiteralIssue

ZodInvalidReturnTypeIssue

ZodInvalidStringIssue

ZodInvalidTypeIssue

ZodInvalidUnionDiscriminatorIssue

ZodNotMultipleOfIssue

ZodUnrecognizedKeysIssue

InputTypeOfTupleWithRest

OutputTypeOfTupleWithRest

ZodDiscriminatedUnionOption

ZodErrorMap

ZodFirstPartySchemaTypes

ZodIssueOptionalMessage

any

map

nan

set

ZodFirstPartyTypeKind

ZodDiscriminatedUnion

ZodDiscriminatedUnionDef

InputTypeOfTupleWithRest

OutputTypeOfTupleWithRest

ZodDiscriminatedUnionOption

ZodFirstPartySchemaTypes

any

map

nan

set

ZodFirstPartyTypeKind

ZodError.ts

ZodError

ZodCustomIssue

ZodInvalidArgumentsIssue

ZodInvalidDateIssue

ZodInvalidEnumValueIssue

ZodInvalidIntersectionTypesIssue

ZodInvalidLiteralIssue

ZodInvalidReturnTypeIssue

ZodInvalidStringIssue

ZodInvalidTypeIssue

ZodInvalidUnionDiscriminatorIssue

ZodInvalidUnionIssue

ZodNotMultipleOfIssue

ZodTooBigIssue

ZodTooSmallIssue

ZodUnrecognizedKeysIssue

ZodIssueOptionalMessage

import * as zod from "https://deno.land/x/zod@v3.17.3/mod.ts";

Namespaces

N objectUtil
N z
N z.objectUtil

Classes

c ParseStatus
c Schema abstract
c z.ParseStatus
c z.Schema abstract
c z.ZodAny
c z.ZodArray
c z.ZodBigInt
c z.ZodBoolean
c z.ZodDate
c z.ZodDefault
c z.ZodDiscriminatedUnion
c z.ZodEffects
c z.ZodEnum
c z.ZodError
c z.ZodFunction
c z.ZodIntersection
c z.ZodLazy
c z.ZodLiteral
c z.ZodMap
c z.ZodNaN
c z.ZodNativeEnum
c z.ZodNever
c z.ZodNull
c z.ZodNullable
c z.ZodNumber
c z.ZodObject
c z.ZodOptional
c z.ZodPromise
c z.ZodRecord
c z.ZodSchema abstract
c z.ZodSet
c z.ZodString
c z.ZodTransformer
c z.ZodTuple
c z.ZodType abstract
c z.ZodUndefined
c z.ZodUnion
c z.ZodUnknown
c z.ZodVoid
c ZodAny
c ZodArray
c ZodBigInt
c ZodBoolean
c ZodDate
c ZodDefault
c ZodDiscriminatedUnion
c ZodEffects
c ZodEnum
c ZodError
c ZodFunction
c ZodIntersection
c ZodLazy
c ZodLiteral
c ZodMap
c ZodNaN
c ZodNativeEnum
c ZodNever
c ZodNull
c ZodNullable
c ZodNumber
c ZodObject
c ZodOptional
c ZodPromise
c ZodRecord
c ZodSchema abstract
c ZodSet
c ZodString
c ZodTransformer
c ZodTuple
c ZodType abstract
c ZodUndefined
c ZodUnion
c ZodUnknown
c ZodVoid

Enums

E z.ZodFirstPartyTypeKind
E ZodFirstPartyTypeKind

Variables

v any
v array
v bigint
v boolean
v custom
v date
v defaultErrorMap
v DIRTY
v discriminatedUnion
v effect
v EMPTY_PATH
v enum
v function
v getParsedType
v instanceof
v intersection
v INVALID
v isAborted
v isAsync
v isDirty
v isValid
v late
v lazy
v literal
v makeIssue
v map
v nan
v nativeEnum
v never
v null
v nullable
v number
v object
v objectUtil.mergeShapes
v oboolean
v OK
v onumber
v optional
v ostring
v overrideErrorMap
v preprocess
v promise
v quotelessJson
v record
v set
v setErrorMap
v strictObject
v string
v transformer
v tuple
v undefined
v union
v unknown
v void
v z.any
v z.array
v z.bigint
v z.boolean
v z.custom
v z.date
v z.defaultErrorMap
v z.DIRTY
v z.discriminatedUnion
v z.effect
v z.EMPTY_PATH
v z.enum
v z.function
v z.getParsedType
v z.instanceof
v z.intersection
v z.INVALID
v z.isAborted
v z.isAsync
v z.isDirty
v z.isValid
v z.late
v z.lazy
v z.literal
v z.makeIssue
v z.map
v z.nan
v z.nativeEnum
v z.never
v z.null
v z.nullable
v z.number
v z.object
v z.objectUtil.mergeShapes
v z.oboolean
v z.OK
v z.onumber
v z.optional
v z.ostring
v z.overrideErrorMap
v z.preprocess
v z.promise
v z.quotelessJson
v z.record
v z.set
v z.setErrorMap
v z.strictObject
v z.string
v z.transformer
v z.tuple
v z.undefined
v z.union
v z.unknown
v z.void
v z.ZodIssueCode
v z.ZodParsedType
v ZodIssueCode
v ZodParsedType

Functions

f addIssueToContext
f z.addIssueToContext

Interfaces

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

Type Aliases

T AnyZodObject
T ArrayCardinality
T ArrayKeys
T AssertArray
T AsyncParseReturnType
T baseObjectInputType
T baseObjectOutputType
T CustomErrorParams
T DenormalizedError
T DIRTY
T Effect
T extendShape
T Indices
T infer
T inferFlattenedErrors
T inferFormattedError
T InnerTypeOfFunction
T input
T InputTypeOfTuple
T InputTypeOfTupleWithRest
T INVALID
T IssueData
T MakeErrorData
T objectInputType
T objectOutputType
T ObjectPair
T objectUtil.addQuestionMarks
T objectUtil.flatten
T objectUtil.identity
T objectUtil.MergeShapes
T objectUtil.noNever
T objectUtil.noNeverKeys
T OK
T OuterTypeOfFunction
T output
T OutputTypeOfTuple
T OutputTypeOfTupleWithRest
T ParseInput
T ParseParams
T ParsePath
T ParsePathComponent
T ParseReturnType
T PreprocessEffect
T Primitive
T Refinement
T RefinementCtx
T RefinementEffect
T SafeParseError
T SafeParseReturnType
T SafeParseSuccess
T Scalars
T SomeZodObject
T StringValidation
T SuperRefinement
T SyncParseReturnType
T TransformEffect
T TypeOf
T typeToFlattenedError
T z.AnyZodObject
T z.ArrayCardinality
T z.ArrayKeys
T z.AssertArray
T z.AsyncParseReturnType
T z.baseObjectInputType
T z.baseObjectOutputType
T z.CustomErrorParams
T z.DenormalizedError
T z.DIRTY
T z.Effect
T z.extendShape
T z.Indices
T z.infer
T z.inferFlattenedErrors
T z.inferFormattedError
T z.InnerTypeOfFunction
T z.input
T z.InputTypeOfTuple
T z.InputTypeOfTupleWithRest
T z.INVALID
T z.IssueData
T z.MakeErrorData
T z.objectInputType
T z.objectOutputType
T z.ObjectPair
T z.objectUtil.addQuestionMarks
T z.objectUtil.flatten
T z.objectUtil.identity
T z.objectUtil.MergeShapes
T z.objectUtil.noNever
T z.objectUtil.noNeverKeys
T z.OK
T z.OuterTypeOfFunction
T z.output
T z.OutputTypeOfTuple
T z.OutputTypeOfTupleWithRest
T z.ParseInput
T z.ParseParams
T z.ParsePath
T z.ParsePathComponent
T z.ParseReturnType
T z.PreprocessEffect
T z.Primitive
T z.Refinement
T z.RefinementCtx
T z.RefinementEffect
T z.SafeParseError
T z.SafeParseReturnType
T z.SafeParseSuccess
T z.Scalars
T z.SomeZodObject
T z.StringValidation
T z.SuperRefinement
T z.SyncParseReturnType
T z.TransformEffect
T z.TypeOf
T z.typeToFlattenedError
T z.ZodDiscriminatedUnionOption
T z.ZodErrorMap
T z.ZodFirstPartySchemaTypes
T z.ZodFormattedError
T z.ZodIssue
T z.ZodIssueBase
T z.ZodIssueCode
T z.ZodIssueOptionalMessage
T z.ZodNonEmptyArray
T z.ZodNullableType
T z.ZodOptionalType
T z.ZodParsedType
T z.ZodRawShape
T z.ZodTupleItems
T z.ZodTypeAny
T ZodDiscriminatedUnionOption
T ZodErrorMap
T ZodFirstPartySchemaTypes
T ZodFormattedError
T ZodIssue
T ZodIssueBase
T ZodIssueCode
T ZodIssueOptionalMessage
T ZodNonEmptyArray
T ZodNullableType
T ZodOptionalType
T ZodParsedType
T ZodRawShape
T ZodTupleItems
T ZodTypeAny