@morojs/moro / z / ZodString
Interface: ZodString
Defined in: node_modules/zod/v4/classic/schemas.d.cts:100
Extends
_ZodString<$ZodStringInternals<string>>
Properties
~~_def~~
_def:
$ZodStringDef
Defined in: node_modules/zod/v4/classic/schemas.d.cts:8
Deprecated
Use .def instead.
Inherited from
~~_input~~
_input:
string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:12
Deprecated
Use z.input<typeof schema> instead.
Inherited from
~~_output~~
_output:
string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:10
Deprecated
Use z.output<typeof schema> instead.
Inherited from
_zod
_zod:
$ZodStringInternals
Defined in: node_modules/zod/v4/core/schemas.d.cts:89
Inherited from
~standard
~standard:
$ZodStandardSchema<ZodString>
Defined in: node_modules/zod/v4/core/schemas.d.cts:90
Inherited from
def
def:
$ZodStringDef
Defined in: node_modules/zod/v4/classic/schemas.d.cts:5
Inherited from
description?
optionaldescription:string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:53
Inherited from
format
format:
null|string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:80
Inherited from
maxLength
maxLength:
null|number
Defined in: node_modules/zod/v4/classic/schemas.d.cts:82
Inherited from
minLength
minLength:
null|number
Defined in: node_modules/zod/v4/classic/schemas.d.cts:81
Inherited from
spa()
spa: (
data,params?) =>Promise<ZodSafeParseResult<string>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:23
Parameters
data
unknown
params?
Returns
Promise<ZodSafeParseResult<string>>
Inherited from
type
type:
"string"
Defined in: node_modules/zod/v4/classic/schemas.d.cts:6
Inherited from
Methods
and()
and<
T>(incoming):ZodIntersection<ZodString,T>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:45
Type Parameters
T
T extends SomeType
Parameters
incoming
T
Returns
ZodIntersection<ZodString, T>
Inherited from
array()
array():
ZodArray<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:43
Returns
ZodArray<ZodString>
Inherited from
~~base64()~~
base64(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:130
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.base64() instead.
~~base64url()~~
base64url(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:132
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.base64url() instead.
brand()
brand<
T>(value?):PropertyKeyextendsT?ZodString:$ZodBranded<ZodString,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 ? ZodString : $ZodBranded<ZodString, T>
Inherited from
catch()
Call Signature
catch(
def):ZodCatch<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:47
Parameters
def
string
Returns
ZodCatch<ZodString>
Inherited from
Call Signature
catch(
def):ZodCatch<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:48
Parameters
def
(ctx) => string
Returns
ZodCatch<ZodString>
Inherited from
check()
check(...
checks):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:13
Parameters
checks
...($ZodCheck<string> | CheckFn<string>)[]
Returns
this
Inherited from
~~cidrv4()~~
cidrv4(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:142
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; version?: "v4"; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
version?
"v4"
Returns
this
Deprecated
Use z.cidrv4() instead.
~~cidrv6()~~
cidrv6(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:144
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; version?: "v6"; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
version?
"v6"
Returns
this
Deprecated
Use z.cidrv6() instead.
clone()
clone(
def?,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:14
Parameters
def?
params?
parent
boolean
Returns
this
Inherited from
~~cuid()~~
cuid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:124
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.cuid() instead.
~~cuid2()~~
cuid2(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:126
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.cuid2() instead.
~~date()~~
date(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:150
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.iso.date() instead.
~~datetime()~~
datetime(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:148
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; local?: boolean; message?: string; offset?: boolean; precision?: null | number; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
local?
boolean
message?
string
Deprecated
This parameter is deprecated. Use error instead.
offset?
boolean
precision?
null | number
Returns
this
Deprecated
Use z.iso.datetime() instead.
decode()
decode(
data,params?):string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:25
Parameters
data
string
params?
Returns
string
Inherited from
decodeAsync()
decodeAsync(
data,params?):Promise<string>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:27
Parameters
data
string
params?
Returns
Promise<string>
Inherited from
default()
Call Signature
default(
def):ZodDefault<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:39
Parameters
def
string
Returns
ZodDefault<ZodString>
Inherited from
Call Signature
default(
def):ZodDefault<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:40
Parameters
def
() => string
Returns
ZodDefault<ZodString>
Inherited from
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
Inherited from
~~duration()~~
duration(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:154
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.iso.duration() instead.
~~e164()~~
e164(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:146
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.e164() instead.
~~email()~~
email(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:102
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.email() instead.
~~emoji()~~
emoji(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:108
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.emoji() instead.
encode()
encode(
data,params?):string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:24
Parameters
data
string
params?
Returns
string
Inherited from
encodeAsync()
encodeAsync(
data,params?):Promise<string>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:26
Parameters
data
string
params?
Returns
Promise<string>
Inherited from
endsWith()
endsWith(
value,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:86
Parameters
value
string
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Inherited from
~~guid()~~
Call Signature
guid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:110
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.guid() instead.
Call Signature
guid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:122
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.guid() instead.
includes()
includes(
value,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:84
Parameters
value
string
params?
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
position?
number
Returns
this
Inherited from
~~ipv4()~~
ipv4(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:138
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.ipv4() instead.
~~ipv6()~~
ipv6(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:140
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.ipv6() instead.
~~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
Inherited from
~~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
Inherited from
~~jwt()~~
jwt(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:106
Parameters
params?
string |
{ abort?: boolean; alg?: JWTAlgorithm; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
alg?
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Deprecated
Use z.jwt() instead.
~~ksuid()~~
ksuid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:136
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.ksuid() instead.
length()
length(
len,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:89
Parameters
len
number
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<NonNullable<$ZodIssueTooSmall<HasLength> | $ZodIssueTooBig<HasLength>>>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<NonNullable<$ZodIssueTooSmall<HasLength> | $ZodIssueTooBig<HasLength>>>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Inherited from
lowercase()
lowercase(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:91
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Inherited from
max()
max(
maxLength,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:88
Parameters
maxLength
number
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooBig<HasLength>>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueTooBig<HasLength>>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Inherited from
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; }
Inherited from
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
Inherited from
min()
min(
minLength,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:87
Parameters
minLength
number
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Inherited from
~~nanoid()~~
nanoid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:120
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.nanoid() instead.
nonempty()
nonempty(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:90
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueTooSmall<HasLength>>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Inherited from
nonoptional()
nonoptional(
params?):ZodNonOptional<ZodString>
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<ZodString>
Inherited from
normalize()
normalize(
form?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:94
Parameters
form?
string & object | "NFC" | "NFD" | "NFKC" | "NFKD"
Returns
this
Inherited from
nullable()
nullable():
ZodNullable<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:37
Returns
ZodNullable<ZodString>
Inherited from
nullish()
nullish():
ZodOptional<ZodNullable<ZodString>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:38
Returns
ZodOptional<ZodNullable<ZodString>>
Inherited from
optional()
optional():
ZodOptional<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:35
Returns
ZodOptional<ZodString>
Inherited from
or()
or<
T>(option):ZodUnion<[ZodString,T]>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:44
Type Parameters
T
T extends SomeType
Parameters
option
T
Returns
ZodUnion<[ZodString, T]>
Inherited from
overwrite()
overwrite(
fn):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:34
Parameters
fn
(x) => string
Returns
this
Inherited from
parse()
parse(
data,params?):string
Defined in: node_modules/zod/v4/classic/schemas.d.cts:19
Parameters
data
unknown
params?
Returns
string
Inherited from
parseAsync()
parseAsync(
data,params?):Promise<string>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:21
Parameters
data
unknown
params?
Returns
Promise<string>
Inherited from
pipe()
pipe<
T>(target):ZodPipe<ZodString,T>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:49
Type Parameters
T
T extends $ZodType<any, string, $ZodTypeInternals<any, string>>
Parameters
target
T | $ZodType<any, string, $ZodTypeInternals<any, string>>
Returns
ZodPipe<ZodString, T>
Inherited from
prefault()
Call Signature
prefault(
def):ZodPrefault<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:41
Parameters
def
() => string
Returns
ZodPrefault<ZodString>
Inherited from
Call Signature
prefault(
def):ZodPrefault<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:42
Parameters
def
string
Returns
ZodPrefault<ZodString>
Inherited from
readonly()
readonly():
ZodReadonly<ZodString>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:50
Returns
ZodReadonly<ZodString>
Inherited from
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
Inherited from
regex()
regex(
regex,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:83
Parameters
regex
RegExp
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Inherited from
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
...ZodString extends R["_schema"] ? undefined extends R["_meta"] ? [$replace<R["_meta"], R["_schema"] & ZodString>?] : [$replace<R["_meta"], R["_schema"] & ZodString>] : ["Incompatible schema"]
Returns
this
Inherited from
safeDecode()
safeDecode(
data,params?):ZodSafeParseResult<string>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:29
Parameters
data
string
params?
Returns
ZodSafeParseResult<string>
Inherited from
safeDecodeAsync()
safeDecodeAsync(
data,params?):Promise<ZodSafeParseResult<string>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:31
Parameters
data
string
params?
Returns
Promise<ZodSafeParseResult<string>>
Inherited from
safeEncode()
safeEncode(
data,params?):ZodSafeParseResult<string>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:28
Parameters
data
string
params?
Returns
ZodSafeParseResult<string>
Inherited from
safeEncodeAsync()
safeEncodeAsync(
data,params?):Promise<ZodSafeParseResult<string>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:30
Parameters
data
string
params?
Returns
Promise<ZodSafeParseResult<string>>
Inherited from
safeParse()
safeParse(
data,params?):ZodSafeParseResult<string>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:20
Parameters
data
unknown
params?
Returns
ZodSafeParseResult<string>
Inherited from
safeParseAsync()
safeParseAsync(
data,params?):Promise<ZodSafeParseResult<string>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:22
Parameters
data
unknown
params?
Returns
Promise<ZodSafeParseResult<string>>
Inherited from
startsWith()
startsWith(
value,params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:85
Parameters
value
string
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
Returns
this
Inherited from
superRefine()
superRefine(
refinement):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:33
Parameters
refinement
(arg, ctx) => void | Promise<void>
Returns
this
Inherited from
~~time()~~
time(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:152
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; precision?: null | number; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
precision?
null | number
Returns
this
Deprecated
Use z.iso.time() instead.
toLowerCase()
toLowerCase():
this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:95
Returns
this
Inherited from
toUpperCase()
toUpperCase():
this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:96
Returns
this
Inherited from
transform()
transform<
NewOut>(transform):ZodPipe<ZodString,ZodTransform<Awaited<NewOut>,string>>
Defined in: node_modules/zod/v4/classic/schemas.d.cts:46
Type Parameters
NewOut
NewOut
Parameters
transform
(arg, ctx) => NewOut | Promise<NewOut>
Returns
ZodPipe<ZodString, ZodTransform<Awaited<NewOut>, string>>
Inherited from
trim()
trim():
this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:93
Returns
this
Inherited from
~~ulid()~~
ulid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:128
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.ulid() instead.
uppercase()
uppercase(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:92
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Inherited from
~~url()~~
url(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:104
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; hostname?: RegExp; message?: string; normalize?: boolean; pattern?: RegExp; protocol?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
hostname?
RegExp
message?
string
Deprecated
This parameter is deprecated. Use error instead.
normalize?
boolean
pattern?
RegExp
protocol?
RegExp
Returns
this
Deprecated
Use z.url() instead.
~~uuid()~~
uuid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:112
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
version?
"v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns
this
Deprecated
Use z.uuid() instead.
~~uuidv4()~~
uuidv4(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:114
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
version?
"v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns
this
Deprecated
Use z.uuid() instead.
~~uuidv6()~~
uuidv6(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:116
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
version?
"v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns
this
Deprecated
Use z.uuid() instead.
~~uuidv7()~~
uuidv7(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:118
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; version?: "v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
version?
"v1" | "v2" | "v3" | "v4" | "v5" | "v6" | "v7" | "v8"
Returns
this
Deprecated
Use z.uuid() instead.
~~xid()~~
xid(
params?):this
Defined in: node_modules/zod/v4/classic/schemas.d.cts:134
Parameters
params?
string |
{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; pattern?: RegExp; }
abort?
boolean
If true, no later checks will be executed if this check fails. Default false.
error?
string | $ZodErrorMap<$ZodIssueInvalidStringFormat>
message?
string
Deprecated
This parameter is deprecated. Use error instead.
pattern?
RegExp
Returns
this
Deprecated
Use z.xid() instead.