Zodiac API Documentation - v0.0.3
    Preparing search index...

    Namespace z

    Namespaces

    util
    objectUtil

    Enumerations

    ZodFirstPartyTypeKind

    Classes

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

    Interfaces

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

    Type Aliases

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

    Variables

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

    Functions

    setErrorMap
    getErrorMap
    addIssueToContext
    datetimeRegex
    custom

    References

    infer → TypeOf
    ZodTransformer → ZodEffects
    Schema → ZodType
    ZodSchema → ZodType
    transformer → effect

    Settings

    Member Visibility

    On This Page

    Namespaces
    Enumerations
    Classes
    Interfaces
    ZodInvalidTypeIssueZodInvalidLiteralIssueZodUnrecognizedKeysIssueZodInvalidUnionIssueZodInvalidUnionDiscriminatorIssueZodInvalidEnumValueIssueZodInvalidArgumentsIssueZodInvalidReturnTypeIssueZodInvalidDateIssueZodInvalidStringIssueZodTooSmallIssueZodTooBigIssueZodInvalidIntersectionTypesIssueZodNotMultipleOfIssueZodNotFiniteIssueZodCustomIssueParseContextParseResultRefinementCtxZodTypeDefZodStringDefZodNumberDefZodBigIntDefZodBooleanDefZodDateDefZodSymbolDefZodUndefinedDefZodNullDefZodAnyDefZodUnknownDefZodNeverDefZodVoidDefZodArrayDefZodObjectDefZodUnionDefZodDiscriminatedUnionDefZodIntersectionDefZodTupleDefZodRecordDefZodMapDefZodSetDefZodFunctionDefZodLazyDefZodLiteralDefZodEnumDefZodNativeEnumDefZodPromiseDefZodEffectsDefZodOptionalDefZodNullableDefZodDefaultDefZodCatchDefZodNaNDefZodBrandedDefZodPipelineDefZodReadonlyDef
    Type Aliases
    inferFlattenedErrorstypeToFlattenedErrorZodIssueCodeZodIssueBaseStringValidationDenormalizedErrorZodIssueOptionalMessageZodIssueZodFormattedErrorinferFormattedErrorIssueDataErrorMapCtxZodErrorMapParseParamsParsePathComponentParsePathParseInputObjectPairINVALIDDIRTYOKSyncParseReturnTypeAsyncParseReturnTypeParseReturnTypePrimitiveScalarsZodParsedTypeZodRawShapeZodTypeAnyTypeOfinputoutputCustomErrorParamsRawCreateParamsProcessedCreateParamsSafeParseSuccessSafeParseErrorSafeParseReturnTypeIpVersionZodStringCheckZodNumberCheckZodBigIntCheckZodDateCheckArrayCardinalityarrayOutputTypeZodNonEmptyArrayUnknownKeysParammergeTypesobjectOutputTypebaseObjectOutputTypeobjectInputTypebaseObjectInputTypeCatchallOutputCatchallInputPassthroughTypedeoptionalSomeZodObjectnoUnrecognizedAnyZodObjectZodUnionOptionsZodDiscriminatedUnionOptionZodTupleItemsAssertArrayOutputTypeOfTupleOutputTypeOfTupleWithRestInputTypeOfTupleInputTypeOfTupleWithRestAnyZodTupleKeySchemaRecordTypeOuterTypeOfFunctionInnerTypeOfFunctionArrayKeysIndicesEnumValuesValuesWriteableFilterEnumtypecastEnumLikeRefinementSuperRefinementRefinementEffectTransformEffectPreprocessEffectEffectZodOptionalTypeZodNullableTypeBRANDZodFirstPartySchemaTypes
    Variables
    Functions
    References