Skip to main content

Interface: ZodURL

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:212

Extends​

Properties​

_def​

_def: $ZodStringFormatDef<"url">

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:11

Deprecated​

Use .def instead.

Inherited from​

ZodStringFormat._def


_input​

_input: string

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:15

Deprecated​

Use z.input<typeof schema> instead.

Inherited from​

ZodStringFormat._input


_output​

_output: string

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:13

Deprecated​

Use z.output<typeof schema> instead.

Inherited from​

ZodStringFormat._output


_zod​

_zod: $ZodURLInternals

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:213

Overrides​

ZodStringFormat._zod


~standard​

~standard: ZodStandardSchemaWithJSON<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:16

Inherited from​

ZodStringFormat.~standard


def​

def: $ZodStringFormatDef<"url">

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

Inherited from​

ZodStringFormat.def


description?​

optional description: string

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:63

Inherited from​

ZodStringFormat.description


format​

format: string | null

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:91

Inherited from​

ZodStringFormat.format


maxLength​

maxLength: number | null

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

Inherited from​

ZodStringFormat.maxLength


minLength​

minLength: number | null

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:92

Inherited from​

ZodStringFormat.minLength


spa()​

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

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<string>>

Inherited from​

ZodStringFormat.spa


type​

type: "string"

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:9

Inherited from​

ZodStringFormat.type

Methods​

and()​

and<T>(incoming): ZodIntersection<ZodURL, T>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:55

Type Parameters​

T​

T extends SomeType

Parameters​

incoming​

T

Returns​

ZodIntersection<ZodURL, T>

Inherited from​

ZodStringFormat.and


apply()​

apply<T, TArgs>(fn, ...args): T

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:85

Type Parameters​

T​

T

TArgs​

TArgs extends unknown[] = []

Parameters​

fn​

(schema, ...args) => T

args​

...TArgs

Returns​

T

Inherited from​

ZodStringFormat.apply


array()​

array(): ZodArray<ZodURL>

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

Returns​

ZodArray<ZodURL>

Inherited from​

ZodStringFormat.array


brand()​

brand<T, Dir>(value?): PropertyKey extends T ? ZodURL : $ZodBranded<ZodURL, T, Dir>

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

Type Parameters​

T​

T extends PropertyKey = PropertyKey

Dir​

Dir extends "inout" | "in" | "out" = "out"

Parameters​

value?​

T

Returns​

PropertyKey extends T ? ZodURL : $ZodBranded<ZodURL, T, Dir>

Inherited from​

ZodStringFormat.brand


catch()​

Call Signature​

catch(def): ZodCatch<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:57

Parameters​
def​

string

Returns​

ZodCatch<ZodURL>

Inherited from​

ZodStringFormat.catch

Call Signature​

catch(def): ZodCatch<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:58

Parameters​
def​

(ctx) => string

Returns​

ZodCatch<ZodURL>

Inherited from​

ZodStringFormat.catch


check()​

check(...checks): this

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

Parameters​

checks​

...($ZodCheck<string> | CheckFn<string>)[]

Returns​

this

Inherited from​

ZodStringFormat.check


clone()​

clone(def?, params?): this

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

Parameters​

def?​

$ZodStringFormatDef<"url">

params?​
parent​

boolean

Returns​

this

Inherited from​

ZodStringFormat.clone


decode()​

decode(data, params?): string

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

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

string

Inherited from​

ZodStringFormat.decode


decodeAsync()​

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

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:36

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

Promise<string>

Inherited from​

ZodStringFormat.decodeAsync


default()​

Call Signature​

default(def): ZodDefault<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:49

Parameters​
def​

string

Returns​

ZodDefault<ZodURL>

Inherited from​

ZodStringFormat.default

Call Signature​

default(def): ZodDefault<ZodURL>

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

Parameters​
def​

() => string

Returns​

ZodDefault<ZodURL>

Inherited from​

ZodStringFormat.default


describe()​

describe(description): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:62

Returns a new instance that has been registered in z.globalRegistry with the specified description

Parameters​

description​

string

Returns​

this

Inherited from​

ZodStringFormat.describe


encode()​

encode(data, params?): string

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:33

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

string

Inherited from​

ZodStringFormat.encode


encodeAsync()​

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

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

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

Promise<string>

Inherited from​

ZodStringFormat.encodeAsync


endsWith()​

endsWith(value, params?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:97

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​

ZodStringFormat.endsWith


exactOptional()​

exactOptional(): ZodExactOptional<ZodURL>

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

Returns​

ZodExactOptional<ZodURL>

Inherited from​

ZodStringFormat.exactOptional


includes()​

includes(value, params?): this

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

Parameters​

value​

string

params?​

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueInvalidStringFormat>; message?: string; position?: 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.

position?​

number

Returns​

this

Inherited from​

ZodStringFormat.includes


isNullable()​

isNullable(): boolean

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:84

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​

ZodStringFormat.isNullable


isOptional()​

isOptional(): boolean

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:75

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​

ZodStringFormat.isOptional


length()​

length(len, params?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:100

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​

ZodStringFormat.length


lowercase()​

lowercase(params?): this

Defined in: packages/agentos/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

Inherited from​

ZodStringFormat.lowercase


max()​

max(maxLength, params?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:99

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​

ZodStringFormat.max


meta()​

Call Signature​

meta(): {[key: string]: unknown; deprecated?: boolean; description?: string; id?: string; title?: string; } | undefined

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:65

Returns the metadata associated with this instance in z.globalRegistry

Returns​

{[key: string]: unknown; deprecated?: boolean; description?: string; id?: string; title?: string; } | undefined

Inherited from​

ZodStringFormat.meta

Call Signature​

meta(data): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:67

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​

ZodStringFormat.meta


min()​

min(minLength, params?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:98

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​

ZodStringFormat.min


nonempty()​

nonempty(params?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:101

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​

ZodStringFormat.nonempty


nonoptional()​

nonoptional(params?): ZodNonOptional<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:46

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

Inherited from​

ZodStringFormat.nonoptional


normalize()​

normalize(form?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:105

Parameters​

form?​

string & object | "NFC" | "NFD" | "NFKC" | "NFKD"

Returns​

this

Inherited from​

ZodStringFormat.normalize


nullable()​

nullable(): ZodNullable<ZodURL>

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

Returns​

ZodNullable<ZodURL>

Inherited from​

ZodStringFormat.nullable


nullish()​

nullish(): ZodOptional<ZodNullable<ZodURL>>

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

Returns​

ZodOptional<ZodNullable<ZodURL>>

Inherited from​

ZodStringFormat.nullish


optional()​

optional(): ZodOptional<ZodURL>

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

Returns​

ZodOptional<ZodURL>

Inherited from​

ZodStringFormat.optional


or()​

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

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:54

Type Parameters​

T​

T extends SomeType

Parameters​

option​

T

Returns​

ZodUnion<[ZodURL, T]>

Inherited from​

ZodStringFormat.or


overwrite()​

overwrite(fn): this

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

Parameters​

fn​

(x) => string

Returns​

this

Inherited from​

ZodStringFormat.overwrite


parse()​

parse(data, params?): string

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

string

Inherited from​

ZodStringFormat.parse


parseAsync()​

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

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

Promise<string>

Inherited from​

ZodStringFormat.parseAsync


pipe()​

pipe<T>(target): ZodPipe<ZodURL, T>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:59

Type Parameters​

T​

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

Parameters​

target​

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

Returns​

ZodPipe<ZodURL, T>

Inherited from​

ZodStringFormat.pipe


prefault()​

Call Signature​

prefault(def): ZodPrefault<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:51

Parameters​
def​

() => string

Returns​

ZodPrefault<ZodURL>

Inherited from​

ZodStringFormat.prefault

Call Signature​

prefault(def): ZodPrefault<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:52

Parameters​
def​

string

Returns​

ZodPrefault<ZodURL>

Inherited from​

ZodStringFormat.prefault


readonly()​

readonly(): ZodReadonly<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:60

Returns​

ZodReadonly<ZodURL>

Inherited from​

ZodStringFormat.readonly


refine()​

refine<Ch>(check, params?): Ch extends (arg) => arg is R ? ZodURL & ZodType<R, string, $ZodTypeInternals<R, string>> : ZodURL

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

Type Parameters​

Ch​

Ch extends (arg) => unknown

Parameters​

check​

Ch

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, the check runs only when this returns true. By default, it is skipped if prior parsing produced aborting issues.

Returns​

Ch extends (arg) => arg is R ? ZodURL & ZodType<R, string, $ZodTypeInternals<R, string>> : ZodURL

Inherited from​

ZodStringFormat.refine


regex()​

regex(regex, params?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:94

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​

ZodStringFormat.regex


register()​

register<R>(registry, ...meta): this

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

Type Parameters​

R​

R extends $ZodRegistry<MetadataType, $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>

Parameters​

registry​

R

meta​

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

Returns​

this

Inherited from​

ZodStringFormat.register


safeDecode()​

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

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

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

ZodSafeParseResult<string>

Inherited from​

ZodStringFormat.safeDecode


safeDecodeAsync()​

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

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

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<string>>

Inherited from​

ZodStringFormat.safeDecodeAsync


safeEncode()​

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

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

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

ZodSafeParseResult<string>

Inherited from​

ZodStringFormat.safeEncode


safeEncodeAsync()​

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

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

Parameters​

data​

string

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<string>>

Inherited from​

ZodStringFormat.safeEncodeAsync


safeParse()​

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

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

ZodSafeParseResult<string>

Inherited from​

ZodStringFormat.safeParse


safeParseAsync()​

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

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<string>>

Inherited from​

ZodStringFormat.safeParseAsync


slugify()​

slugify(): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:108

Returns​

this

Inherited from​

ZodStringFormat.slugify


startsWith()​

startsWith(value, params?): this

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

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​

ZodStringFormat.startsWith


superRefine()​

superRefine(refinement, params?): this

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

Parameters​

refinement​

(arg, ctx) => void | Promise<void>

params?​

$ZodSuperRefineParams

Returns​

this

Inherited from​

ZodStringFormat.superRefine


toJSONSchema()​

toJSONSchema(params?): ZodStandardJSONSchemaPayload<ZodURL>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:18

Converts this schema to a JSON Schema representation.

Parameters​

params?​

ToJSONSchemaParams

Returns​

ZodStandardJSONSchemaPayload<ZodURL>

Inherited from​

ZodStringFormat.toJSONSchema


toLowerCase()​

toLowerCase(): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:106

Returns​

this

Inherited from​

ZodStringFormat.toLowerCase


toUpperCase()​

toUpperCase(): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:107

Returns​

this

Inherited from​

ZodStringFormat.toUpperCase


transform()​

transform<NewOut>(transform): ZodPipe<ZodURL, ZodTransform<Awaited<NewOut>, string>>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:56

Type Parameters​

NewOut​

NewOut

Parameters​

transform​

(arg, ctx) => NewOut | Promise<NewOut>

Returns​

ZodPipe<ZodURL, ZodTransform<Awaited<NewOut>, string>>

Inherited from​

ZodStringFormat.transform


trim()​

trim(): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:104

Returns​

this

Inherited from​

ZodStringFormat.trim


uppercase()​

uppercase(params?): this

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:103

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​

ZodStringFormat.uppercase


validate()​

validate(data, params?): data is string

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

data is string

Inherited from​

ZodStringFormat.validate


validateAsync()​

validateAsync(data, params?): Promise<boolean>

Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:32

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

Promise<boolean>

Inherited from​

ZodStringFormat.validateAsync


with()​

with(...checks): this

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

Parameters​

checks​

...($ZodCheck<string> | CheckFn<string>)[]

Returns​

this

Inherited from​

ZodStringFormat.with