@morojs/moro

@morojs/moro / z / ZodStringFormat

Interface: ZodStringFormat<Format>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:159

Extends

• _ZodString<$ZodStringFormatInternals<Format>>

Extended by

• ZodEmail
• ZodGUID
• ZodUUID
• ZodURL
• ZodEmoji
• ZodNanoID
• ZodCUID
• ZodCUID2
• ZodULID
• ZodXID
• ZodKSUID
• ZodIPv4
• ZodIPv6
• ZodCIDRv4
• ZodCIDRv6
• ZodBase64
• ZodBase64URL
• ZodE164
• ZodJWT
• ZodCustomStringFormat
• ZodISODateTime
• ZodISODate
• ZodISOTime
• ZodISODuration

Type Parameters

Format

Format extends string = string

Properties

~~_def~~

_def: $ZodStringFormatDef<Format>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:8

Deprecated

Use .def instead.

Inherited from

_ZodString._def

~~_input~~

_input: string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:12

Deprecated

Use z.input<typeof schema> instead.

Inherited from

_ZodString._input

~~_output~~

_output: string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:10

Deprecated

Use z.output<typeof schema> instead.

Inherited from

_ZodString._output

_zod

_zod: $ZodStringFormatInternals

Defined in: node_modules/zod/v4/core/schemas.d.cts:89

Inherited from

_ZodString._zod

~standard

~standard: $ZodStandardSchema<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/core/schemas.d.cts:90

Inherited from

_ZodString.~standard

def

def: $ZodStringFormatDef<Format>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:5

Inherited from

_ZodString.def

description?

optional description: string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:53

Inherited from

_ZodString.description

format

format: null | string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:80

Inherited from

_ZodString.format

maxLength

maxLength: null | number

Defined in: node_modules/zod/v4/classic/schemas.d.cts:82

Inherited from

_ZodString.maxLength

minLength

minLength: null | number

Defined in: node_modules/zod/v4/classic/schemas.d.cts:81

Inherited from

_ZodString.minLength

spa()

spa: (data, params?) => Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:23

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

_ZodString.spa

type

type: "string"

Defined in: node_modules/zod/v4/classic/schemas.d.cts:6

Inherited from

_ZodString.type

Methods

and()

and<T>(incoming): ZodIntersection<ZodStringFormat<Format>, T>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:45

Type Parameters

T

T extends SomeType

Parameters

incoming

T

Returns

ZodIntersection<ZodStringFormat<Format>, T>

Inherited from

_ZodString.and

array()

array(): ZodArray<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:43

Returns

ZodArray<ZodStringFormat<Format>>

Inherited from

_ZodString.array

brand()

brand<T>(value?): PropertyKey extends T ? ZodStringFormat<Format> : $ZodBranded<ZodStringFormat<Format>, 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 ? ZodStringFormat<Format> : $ZodBranded<ZodStringFormat<Format>, T>

Inherited from

_ZodString.brand

catch()

Call Signature

catch(def): ZodCatch<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:47

Parameters

def

string

Returns

ZodCatch<ZodStringFormat<Format>>

Inherited from

_ZodString.catch

Call Signature

catch(def): ZodCatch<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:48

Parameters

def

(ctx) => string

Returns

ZodCatch<ZodStringFormat<Format>>

Inherited from

_ZodString.catch

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

_ZodString.check

clone()

clone(def?, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:14

Parameters

def?

$ZodStringFormatDef<Format>

params?

parent

boolean

Returns

this

Inherited from

_ZodString.clone

decode()

decode(data, params?): string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:25

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

string

Inherited from

_ZodString.decode

decodeAsync()

decodeAsync(data, params?): Promise<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:27

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<string>

Inherited from

_ZodString.decodeAsync

default()

Call Signature

default(def): ZodDefault<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:39

Parameters

def

string

Returns

ZodDefault<ZodStringFormat<Format>>

Inherited from

_ZodString.default

Call Signature

default(def): ZodDefault<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:40

Parameters

def

() => string

Returns

ZodDefault<ZodStringFormat<Format>>

Inherited from

_ZodString.default

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

_ZodString.describe

encode()

encode(data, params?): string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:24

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

string

Inherited from

_ZodString.encode

encodeAsync()

encodeAsync(data, params?): Promise<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:26

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<string>

Inherited from

_ZodString.encodeAsync

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

_ZodString.endsWith

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

_ZodString.includes

~~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

_ZodString.isNullable

~~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

_ZodString.isOptional

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

_ZodString.length

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

_ZodString.lowercase

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

_ZodString.max

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

_ZodString.meta

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

_ZodString.meta

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

_ZodString.min

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

_ZodString.nonempty

nonoptional()

nonoptional(params?): ZodNonOptional<ZodStringFormat<Format>>

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<ZodStringFormat<Format>>

Inherited from

_ZodString.nonoptional

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

_ZodString.normalize

nullable()

nullable(): ZodNullable<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:37

Returns

ZodNullable<ZodStringFormat<Format>>

Inherited from

_ZodString.nullable

nullish()

nullish(): ZodOptional<ZodNullable<ZodStringFormat<Format>>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:38

Returns

ZodOptional<ZodNullable<ZodStringFormat<Format>>>

Inherited from

_ZodString.nullish

optional()

optional(): ZodOptional<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:35

Returns

ZodOptional<ZodStringFormat<Format>>

Inherited from

_ZodString.optional

or()

or<T>(option): ZodUnion<[ZodStringFormat<Format>, T]>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:44

Type Parameters

T

T extends SomeType

Parameters

option

T

Returns

ZodUnion<[ZodStringFormat<Format>, T]>

Inherited from

_ZodString.or

overwrite()

overwrite(fn): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:34

Parameters

fn

(x) => string

Returns

this

Inherited from

_ZodString.overwrite

parse()

parse(data, params?): string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:19

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

string

Inherited from

_ZodString.parse

parseAsync()

parseAsync(data, params?): Promise<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:21

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<string>

Inherited from

_ZodString.parseAsync

pipe()

pipe<T>(target): ZodPipe<ZodStringFormat<Format>, 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

$ZodType<any, string, $ZodTypeInternals<any, string>> | T

Returns

ZodPipe<ZodStringFormat<Format>, T>

Inherited from

_ZodString.pipe

prefault()

Call Signature

prefault(def): ZodPrefault<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:41

Parameters

def

() => string

Returns

ZodPrefault<ZodStringFormat<Format>>

Inherited from

_ZodString.prefault

Call Signature

prefault(def): ZodPrefault<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:42

Parameters

def

string

Returns

ZodPrefault<ZodStringFormat<Format>>

Inherited from

_ZodString.prefault

readonly()

readonly(): ZodReadonly<ZodStringFormat<Format>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:50

Returns

ZodReadonly<ZodStringFormat<Format>>

Inherited from

_ZodString.readonly

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

_ZodString.refine

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

_ZodString.regex

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

...ZodStringFormat<Format> extends R["_schema"] ? undefined extends R["_meta"] ? [$replace<R["_meta"], R["_schema"] & ZodStringFormat<Format>>?] : [$replace<R["_meta"], R["_schema"] & ZodStringFormat<Format>>] : ["Incompatible schema"]

Returns

this

Inherited from

_ZodString.register

safeDecode()

safeDecode(data, params?): ZodSafeParseResult<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:29

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<string>

Inherited from

_ZodString.safeDecode

safeDecodeAsync()

safeDecodeAsync(data, params?): Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:31

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

_ZodString.safeDecodeAsync

safeEncode()

safeEncode(data, params?): ZodSafeParseResult<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:28

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<string>

Inherited from

_ZodString.safeEncode

safeEncodeAsync()

safeEncodeAsync(data, params?): Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:30

Parameters

data

string

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

_ZodString.safeEncodeAsync

safeParse()

safeParse(data, params?): ZodSafeParseResult<string>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:20

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<string>

Inherited from

_ZodString.safeParse

safeParseAsync()

safeParseAsync(data, params?): Promise<ZodSafeParseResult<string>>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:22

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<string>>

Inherited from

_ZodString.safeParseAsync

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

_ZodString.startsWith

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

_ZodString.superRefine

toLowerCase()

toLowerCase(): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:95

Returns

this

Inherited from

_ZodString.toLowerCase

toUpperCase()

toUpperCase(): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:96

Returns

this

Inherited from

_ZodString.toUpperCase

transform()

transform<NewOut>(transform): ZodPipe<ZodStringFormat<Format>, 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<ZodStringFormat<Format>, ZodTransform<Awaited<NewOut>, string>>

Inherited from

_ZodString.transform

trim()

trim(): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:93

Returns

this

Inherited from

_ZodString.trim

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

_ZodString.uppercase