Interface: ZodEmoji
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:199
Extends
ZodStringFormat<"emoji">
Properties
_def
_def:
$ZodStringFormatDef<"emoji">
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:10
Deprecated
Use .def instead.
Inherited from
_input
_input:
string
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:14
Deprecated
Use z.input<typeof schema> instead.
Inherited from
_output
_output:
string
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:12
Deprecated
Use z.output<typeof schema> instead.
Inherited from
_zod
_zod:
$ZodEmojiInternals
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:200
Overrides
~standard
~standard:
ZodStandardSchemaWithJSON<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:15
Inherited from
def
def:
$ZodStringFormatDef<"emoji">
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:7
Inherited from
description?
optionaldescription:string
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:60
Inherited from
format
format:
string|null
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:88
Inherited from
maxLength
maxLength:
number|null
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:90
Inherited from
minLength
minLength:
number|null
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:89
Inherited from
spa()
spa: (
data,params?) =>Promise<ZodSafeParseResult<string>>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:29
Parameters
data
unknown
params?
Returns
Promise<ZodSafeParseResult<string>>
Inherited from
type
type:
"string"
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:8
Inherited from
Methods
and()
and<
T>(incoming):ZodIntersection<ZodEmoji,T>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:52
Type Parameters
T
T extends SomeType
Parameters
incoming
T
Returns
ZodIntersection<ZodEmoji, T>
Inherited from
apply()
apply<
T>(fn):T
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:82
Type Parameters
T
T
Parameters
fn
(schema) => T
Returns
T
Inherited from
array()
array():
ZodArray<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:50
Returns
ZodArray<ZodEmoji>
Inherited from
brand()
brand<
T,Dir>(value?):PropertyKeyextendsT?ZodEmoji:$ZodBranded<ZodEmoji,T,Dir>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:24
Type Parameters
T
T extends PropertyKey = PropertyKey
Dir
Dir extends "inout" | "in" | "out" = "out"
Parameters
value?
T
Returns
PropertyKey extends T ? ZodEmoji : $ZodBranded<ZodEmoji, T, Dir>
Inherited from
catch()
Call Signature
catch(
def):ZodCatch<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:54
Parameters
def
string
Returns
ZodCatch<ZodEmoji>
Inherited from
Call Signature
catch(
def):ZodCatch<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:55
Parameters
def
(ctx) => string
Returns
ZodCatch<ZodEmoji>
Inherited from
check()
check(...
checks):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:18
Parameters
checks
...($ZodCheck<string> | CheckFn<string>)[]
Returns
this
Inherited from
clone()
clone(
def?,params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:20
Parameters
def?
$ZodStringFormatDef<"emoji">
params?
parent
boolean
Returns
this
Inherited from
decode()
decode(
data,params?):string
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:31
Parameters
data
string
params?
Returns
string
Inherited from
decodeAsync()
decodeAsync(
data,params?):Promise<string>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:33
Parameters
data
string
params?
Returns
Promise<string>
Inherited from
default()
Call Signature
default(
def):ZodDefault<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:46
Parameters
def
string
Returns
ZodDefault<ZodEmoji>
Inherited from
Call Signature
default(
def):ZodDefault<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:47
Parameters
def
() => string
Returns
ZodDefault<ZodEmoji>
Inherited from
describe()
describe(
description):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:59
Returns a new instance that has been registered in z.globalRegistry with the specified description
Parameters
description
string
Returns
this
Inherited from
encode()
encode(
data,params?):string
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:30
Parameters
data
string
params?
Returns
string
Inherited from
encodeAsync()
encodeAsync(
data,params?):Promise<string>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:32
Parameters
data
string
params?
Returns
Promise<string>
Inherited from
endsWith()
endsWith(
value,params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:94
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
exactOptional()
exactOptional():
ZodExactOptional<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:42
Returns
ZodExactOptional<ZodEmoji>
Inherited from
includes()
includes(
value,params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:92
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
isNullable()
isNullable():
boolean
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:81
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: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:72
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
length()
length(
len,params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:97
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: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:99
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: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:96
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(): {[
key:string]:unknown;deprecated?:boolean;description?:string;id?:string;title?:string; } |undefined
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:62
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
Call Signature
meta(
data):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:64
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: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:95
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
nonempty()
nonempty(
params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:98
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<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:43
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<ZodEmoji>
Inherited from
normalize()
normalize(
form?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:102
Parameters
form?
string & object | "NFC" | "NFD" | "NFKC" | "NFKD"
Returns
this
Inherited from
nullable()
nullable():
ZodNullable<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:44
Returns
ZodNullable<ZodEmoji>
Inherited from
nullish()
nullish():
ZodOptional<ZodNullable<ZodEmoji>>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:45
Returns
ZodOptional<ZodNullable<ZodEmoji>>
Inherited from
optional()
optional():
ZodOptional<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:41
Returns
ZodOptional<ZodEmoji>
Inherited from
or()
or<
T>(option):ZodUnion<[ZodEmoji,T]>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:51
Type Parameters
T
T extends SomeType
Parameters
option
T
Returns
ZodUnion<[ZodEmoji, T]>
Inherited from
overwrite()
overwrite(
fn):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:40
Parameters
fn
(x) => string
Returns
this
Inherited from
parse()
parse(
data,params?):string
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:25
Parameters
data
unknown
params?
Returns
string
Inherited from
parseAsync()
parseAsync(
data,params?):Promise<string>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:27
Parameters
data
unknown
params?
Returns
Promise<string>
Inherited from
pipe()
pipe<
T>(target):ZodPipe<ZodEmoji,T>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:56
Type Parameters
T
T extends $ZodType<any, string, $ZodTypeInternals<any, string>>
Parameters
target
$ZodType<any, string, $ZodTypeInternals<any, string>> | T
Returns
ZodPipe<ZodEmoji, T>
Inherited from
prefault()
Call Signature
prefault(
def):ZodPrefault<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:48
Parameters
def
() => string
Returns
ZodPrefault<ZodEmoji>
Inherited from
Call Signature
prefault(
def):ZodPrefault<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:49
Parameters
def
string
Returns
ZodPrefault<ZodEmoji>
Inherited from
readonly()
readonly():
ZodReadonly<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:57
Returns
ZodReadonly<ZodEmoji>
Inherited from
refine()
refine<
Ch>(check,params?):Chextends (arg) =>arg is R?ZodEmoji&ZodType<R,string,$ZodTypeInternals<R,string>> :ZodEmoji
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:38
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 ? ZodEmoji & ZodType<R, string, $ZodTypeInternals<R, string>> : ZodEmoji
Inherited from
regex()
regex(
regex,params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:91
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: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:23
Type Parameters
R
R extends $ZodRegistry<MetadataType, $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>
Parameters
registry
R
meta
...ZodEmoji extends R["_schema"] ? undefined extends R["_meta"] ? [$replace<R["_meta"], R["_schema"] & ZodEmoji>?] : [$replace<R["_meta"], R["_schema"] & ZodEmoji>] : ["Incompatible schema"]
Returns
this
Inherited from
safeDecode()
safeDecode(
data,params?):ZodSafeParseResult<string>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:35
Parameters
data
string
params?
Returns
ZodSafeParseResult<string>
Inherited from
safeDecodeAsync()
safeDecodeAsync(
data,params?):Promise<ZodSafeParseResult<string>>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:37
Parameters
data
string
params?
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:34
Parameters
data
string
params?
Returns
ZodSafeParseResult<string>
Inherited from
safeEncodeAsync()
safeEncodeAsync(
data,params?):Promise<ZodSafeParseResult<string>>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:36
Parameters
data
string
params?
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:26
Parameters
data
unknown
params?
Returns
ZodSafeParseResult<string>
Inherited from
safeParseAsync()
safeParseAsync(
data,params?):Promise<ZodSafeParseResult<string>>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:28
Parameters
data
unknown
params?
Returns
Promise<ZodSafeParseResult<string>>
Inherited from
ZodStringFormat.safeParseAsync
slugify()
slugify():
this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:105
Returns
this
Inherited from
startsWith()
startsWith(
value,params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:93
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,params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:39
Parameters
refinement
(arg, ctx) => void | Promise<void>
params?
Returns
this
Inherited from
toJSONSchema()
toJSONSchema(
params?):ZodStandardJSONSchemaPayload<ZodEmoji>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:17
Converts this schema to a JSON Schema representation.
Parameters
params?
Returns
ZodStandardJSONSchemaPayload<ZodEmoji>
Inherited from
toLowerCase()
toLowerCase():
this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:103
Returns
this
Inherited from
toUpperCase()
toUpperCase():
this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:104
Returns
this
Inherited from
transform()
transform<
NewOut>(transform):ZodPipe<ZodEmoji,ZodTransform<Awaited<NewOut>,string>>
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:53
Type Parameters
NewOut
NewOut
Parameters
transform
(arg, ctx) => NewOut | Promise<NewOut>
Returns
ZodPipe<ZodEmoji, ZodTransform<Awaited<NewOut>, string>>
Inherited from
trim()
trim():
this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:101
Returns
this
Inherited from
uppercase()
uppercase(
params?):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:100
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
with()
with(...
checks):this
Defined in: packages/agentos/node_modules/zod/v4/classic/schemas.d.cts:19
Parameters
checks
...($ZodCheck<string> | CheckFn<string>)[]
Returns
this