@morojs/moro / z / ZodType
Interface: ZodType<Output, Input, Internals>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:4
Extends
$ZodType
<Output
,Input
,Internals
>
Extended by
Type Parameters
Output
Output
= unknown
Input
Input
= unknown
Internals
Internals
extends $ZodTypeInternals
<Output
, Input
> = $ZodTypeInternals
<Output
, Input
>
Properties
~~_def~~
_def:
Internals
["def"
]
Defined in: node_modules/zod/v4/classic/schemas.d.cts:8
Deprecated
Use .def
instead.
~~_input~~
_input:
Internals
["input"
]
Defined in: node_modules/zod/v4/classic/schemas.d.cts:12
Deprecated
Use z.input<typeof schema>
instead.
~~_output~~
_output:
Internals
["output"
]
Defined in: node_modules/zod/v4/classic/schemas.d.cts:10
Deprecated
Use z.output<typeof schema>
instead.
_zod
_zod:
Internals
Defined in: node_modules/zod/v4/core/schemas.d.cts:89
Inherited from
~standard
~standard:
$ZodStandardSchema
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/core/schemas.d.cts:90
Inherited from
def
def:
Internals
["def"
]
Defined in: node_modules/zod/v4/classic/schemas.d.cts:5
description?
optional
description:string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:53
spa()
spa: (
data
,params?
) =>Promise
<ZodSafeParseResult
<output
<ZodType
<Output
,Input
,Internals
>>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:23
Parameters
data
unknown
params?
Returns
Promise
<ZodSafeParseResult
<output
<ZodType
<Output
, Input
, Internals
>>>>
type
type:
Internals
["def"
]["type"
]
Defined in: node_modules/zod/v4/classic/schemas.d.cts:6
Methods
and()
and<
T
>(incoming
):ZodIntersection
<ZodType
<Output
,Input
,Internals
>,T
>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:45
Type Parameters
T
T
extends SomeType
Parameters
incoming
T
Returns
ZodIntersection
<ZodType
<Output
, Input
, Internals
>, T
>
array()
array():
ZodArray
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:43
Returns
ZodArray
<ZodType
<Output
, Input
, Internals
>>
brand()
brand<
T
>(value?
):PropertyKey
extendsT
?ZodType
<Output
,Input
,Internals
> :$ZodBranded
<ZodType
<Output
,Input
,Internals
>,T
>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:18
Type Parameters
T
T
extends PropertyKey
= PropertyKey
Parameters
value?
T
Returns
PropertyKey
extends T
? ZodType
<Output
, Input
, Internals
> : $ZodBranded
<ZodType
<Output
, Input
, Internals
>, T
>
catch()
Call Signature
catch(
def
):ZodCatch
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:47
Parameters
def
output
<ZodType
<Output
, Input
, Internals
>>
Returns
ZodCatch
<ZodType
<Output
, Input
, Internals
>>
Call Signature
catch(
def
):ZodCatch
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:48
Parameters
def
(ctx
) => output
<ZodType
<Output
, Input
, Internals
>>
Returns
ZodCatch
<ZodType
<Output
, Input
, Internals
>>
check()
check(...
checks
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:13
Parameters
checks
...(CheckFn
<output
<ZodType
<Output
, Input
, Internals
>>> | $ZodCheck
<output
<ZodType
<Output
, Input
, Internals
>>>)[]
Returns
this
clone()
clone(
def?
,params?
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:14
Parameters
def?
Internals
["def"
]
params?
parent
boolean
Returns
this
decode()
decode(
data
,params?
):output
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:25
Parameters
data
input
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
output
<ZodType
<Output
, Input
, Internals
>>
decodeAsync()
decodeAsync(
data
,params?
):Promise
<output
<ZodType
<Output
,Input
,Internals
>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:27
Parameters
data
input
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
Promise
<output
<ZodType
<Output
, Input
, Internals
>>>
default()
Call Signature
default(
def
):ZodDefault
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:39
Parameters
def
output
<ZodType
<Output
, Input
, Internals
>>
Returns
ZodDefault
<ZodType
<Output
, Input
, Internals
>>
Call Signature
default(
def
):ZodDefault
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:40
Parameters
def
() => NoUndefined
<output
<ZodType
<Output
, Input
, Internals
>>>
Returns
ZodDefault
<ZodType
<Output
, Input
, Internals
>>
describe()
describe(
description
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:52
Returns a new instance that has been registered in z.globalRegistry
with the specified description
Parameters
description
string
Returns
this
encode()
encode(
data
,params?
):input
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:24
Parameters
data
output
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
input
<ZodType
<Output
, Input
, Internals
>>
encodeAsync()
encodeAsync(
data
,params?
):Promise
<input
<ZodType
<Output
,Input
,Internals
>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:26
Parameters
data
output
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
Promise
<input
<ZodType
<Output
, Input
, Internals
>>>
~~isNullable()~~
isNullable():
boolean
Defined in: node_modules/zod/v4/classic/schemas.d.cts:74
Returns
boolean
Deprecated
Try safe-parsing null
(this is what isNullable
does internally):
const schema = z.string().nullable(); const isNullable = schema.safeParse(null).success; // true
~~isOptional()~~
isOptional():
boolean
Defined in: node_modules/zod/v4/classic/schemas.d.cts:65
Returns
boolean
Deprecated
Try safe-parsing undefined
(this is what isOptional
does internally):
const schema = z.string().optional(); const isOptional = schema.safeParse(undefined).success; // true
meta()
Call Signature
meta():
undefined
| {[key
:string
]:unknown
;deprecated?
:boolean
;description?
:string
;id?
:string
;title?
:string
; }
Defined in: node_modules/zod/v4/classic/schemas.d.cts:55
Returns the metadata associated with this instance in z.globalRegistry
Returns
undefined
| {[key
: string
]: unknown
; deprecated?
: boolean
; description?
: string
; id?
: string
; title?
: string
; }
Call Signature
meta(
data
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:57
Returns a new instance that has been registered in z.globalRegistry
with the specified metadata
Parameters
data
deprecated?
boolean
description?
string
id?
string
title?
string
Returns
this
nonoptional()
nonoptional(
params?
):ZodNonOptional
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:36
Parameters
params?
string
|
{ error?
: string
| $ZodErrorMap
<$ZodIssueInvalidType
<unknown
>>; message?
: string
; }
error?
string
| $ZodErrorMap
<$ZodIssueInvalidType
<unknown
>>
message?
string
Deprecated
This parameter is deprecated. Use error
instead.
Returns
ZodNonOptional
<ZodType
<Output
, Input
, Internals
>>
nullable()
nullable():
ZodNullable
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:37
Returns
ZodNullable
<ZodType
<Output
, Input
, Internals
>>
nullish()
nullish():
ZodOptional
<ZodNullable
<ZodType
<Output
,Input
,Internals
>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:38
Returns
ZodOptional
<ZodNullable
<ZodType
<Output
, Input
, Internals
>>>
optional()
optional():
ZodOptional
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:35
Returns
ZodOptional
<ZodType
<Output
, Input
, Internals
>>
or()
or<
T
>(option
):ZodUnion
<[ZodType
<Output
,Input
,Internals
>,T
]>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:44
Type Parameters
T
T
extends SomeType
Parameters
option
T
Returns
ZodUnion
<[ZodType
<Output
, Input
, Internals
>, T
]>
overwrite()
overwrite(
fn
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:34
Parameters
fn
(x
) => output
<ZodType
<Output
, Input
, Internals
>>
Returns
this
parse()
parse(
data
,params?
):output
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:19
Parameters
data
unknown
params?
Returns
output
<ZodType
<Output
, Input
, Internals
>>
parseAsync()
parseAsync(
data
,params?
):Promise
<output
<ZodType
<Output
,Input
,Internals
>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:21
Parameters
data
unknown
params?
Returns
Promise
<output
<ZodType
<Output
, Input
, Internals
>>>
pipe()
pipe<
T
>(target
):ZodPipe
<ZodType
<Output
,Input
,Internals
>,T
>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:49
Type Parameters
T
T
extends $ZodType
<any
, output
<ZodType
<Output
, Input
, Internals
>>, $ZodTypeInternals
<any
, output
<ZodType
<Output
, Input
, Internals
>>>>
Parameters
target
T
| $ZodType
<any
, output
<ZodType
<Output
, Input
, Internals
>>, $ZodTypeInternals
<any
, output
<ZodType
<Output
, Input
, Internals
>>>>
Returns
ZodPipe
<ZodType
<Output
, Input
, Internals
>, T
>
prefault()
Call Signature
prefault(
def
):ZodPrefault
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:41
Parameters
def
() => input
<ZodType
<Output
, Input
, Internals
>>
Returns
ZodPrefault
<ZodType
<Output
, Input
, Internals
>>
Call Signature
prefault(
def
):ZodPrefault
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:42
Parameters
def
input
<ZodType
<Output
, Input
, Internals
>>
Returns
ZodPrefault
<ZodType
<Output
, Input
, Internals
>>
readonly()
readonly():
ZodReadonly
<ZodType
<Output
,Input
,Internals
>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:50
Returns
ZodReadonly
<ZodType
<Output
, Input
, Internals
>>
refine()
refine(
check
,params?
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:32
Parameters
check
(arg
) => unknown
params?
string
|
{ abort?
: boolean
; error?
: string
| $ZodErrorMap
<NonNullable
<$ZodIssue
>>; message?
: string
; params?
: Record
<string
, any
>; path?
: PropertyKey
[]; when?
: (payload
) => boolean
; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false
.
error?
string
| $ZodErrorMap
<NonNullable
<$ZodIssue
>>
message?
string
Deprecated
This parameter is deprecated. Use error
instead.
params?
Record
<string
, any
>
path?
PropertyKey
[]
when?
(payload
) => boolean
If provided, this check will only be executed if the function returns true
. Defaults to payload => z.util.isAborted(payload)
.
Returns
this
register()
register<
R
>(registry
, ...meta
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:17
Type Parameters
R
R
extends $ZodRegistry
<MetadataType
, $ZodType
<unknown
, unknown
, $ZodTypeInternals
<unknown
, unknown
>>>
Parameters
registry
R
meta
...ZodType
<Output
, Input
, Internals
> extends R
["_schema"
] ? undefined
extends R
["_meta"
] ? [$replace
<R
["_meta"
], R
["_schema"
] & ZodType
<Output
, Input
, Internals
>>?] : [$replace
<R
["_meta"
], R
["_schema"
] & ZodType
<Output
, Input
, Internals
>>] : ["Incompatible schema"
]
Returns
this
safeDecode()
safeDecode(
data
,params?
):ZodSafeParseResult
<output
<ZodType
<Output
,Input
,Internals
>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:29
Parameters
data
input
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
ZodSafeParseResult
<output
<ZodType
<Output
, Input
, Internals
>>>
safeDecodeAsync()
safeDecodeAsync(
data
,params?
):Promise
<ZodSafeParseResult
<output
<ZodType
<Output
,Input
,Internals
>>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:31
Parameters
data
input
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
Promise
<ZodSafeParseResult
<output
<ZodType
<Output
, Input
, Internals
>>>>
safeEncode()
safeEncode(
data
,params?
):ZodSafeParseResult
<input
<ZodType
<Output
,Input
,Internals
>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:28
Parameters
data
output
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
ZodSafeParseResult
<input
<ZodType
<Output
, Input
, Internals
>>>
safeEncodeAsync()
safeEncodeAsync(
data
,params?
):Promise
<ZodSafeParseResult
<input
<ZodType
<Output
,Input
,Internals
>>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:30
Parameters
data
output
<ZodType
<Output
, Input
, Internals
>>
params?
Returns
Promise
<ZodSafeParseResult
<input
<ZodType
<Output
, Input
, Internals
>>>>
safeParse()
safeParse(
data
,params?
):ZodSafeParseResult
<output
<ZodType
<Output
,Input
,Internals
>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:20
Parameters
data
unknown
params?
Returns
ZodSafeParseResult
<output
<ZodType
<Output
, Input
, Internals
>>>
safeParseAsync()
safeParseAsync(
data
,params?
):Promise
<ZodSafeParseResult
<output
<ZodType
<Output
,Input
,Internals
>>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:22
Parameters
data
unknown
params?
Returns
Promise
<ZodSafeParseResult
<output
<ZodType
<Output
, Input
, Internals
>>>>
superRefine()
superRefine(
refinement
):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:33
Parameters
refinement
(arg
, ctx
) => void
| Promise
<void
>
Returns
this
transform()
transform<
NewOut
>(transform
):ZodPipe
<ZodType
<Output
,Input
,Internals
>,ZodTransform
<Awaited
<NewOut
>,output
<ZodType
<Output
,Input
,Internals
>>>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:46
Type Parameters
NewOut
NewOut
Parameters
transform
(arg
, ctx
) => NewOut
| Promise
<NewOut
>
Returns
ZodPipe
<ZodType
<Output
, Input
, Internals
>, ZodTransform
<Awaited
<NewOut
>, output
<ZodType
<Output
, Input
, Internals
>>>>