Interface: ZodTemplateLiteral<Template>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:732
Extends
_ZodType<$ZodTemplateLiteralInternals<Template>>.$ZodTemplateLiteral<Template>
Type Parameters
Template
Template extends string = string
Properties
_def
_def:
$ZodTemplateLiteralDef
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:11
Deprecated
Use .def instead.
Inherited from
_input
_input:
Template
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:15
Deprecated
Use z.input<typeof schema> instead.
Inherited from
_output
_output:
Template
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:13
Deprecated
Use z.output<typeof schema> instead.
Inherited from
_zod
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/core/schemas.d.cts:111
Inherited from
~standard
~standard:
ZodStandardSchemaWithJSON<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:733
Overrides
def
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:8
Inherited from
description?
optionaldescription:string
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:63
Inherited from
spa()
spa: (
data,params?) =>Promise<ZodSafeParseResult<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:30
Parameters
data
unknown
params?
Returns
Promise<ZodSafeParseResult<Template>>
Inherited from
type
type:
"template_literal"
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:9
Inherited from
Methods
and()
and<
T>(incoming):ZodIntersection<ZodTemplateLiteral<Template>,T>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:55
Type Parameters
T
T extends SomeType
Parameters
incoming
T
Returns
ZodIntersection<ZodTemplateLiteral<Template>, T>
Inherited from
apply()
apply<
T,TArgs>(fn, ...args):T
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/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
array()
array():
ZodArray<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:53
Returns
ZodArray<ZodTemplateLiteral<Template>>
Inherited from
brand()
brand<
T,Dir>(value?):PropertyKeyextendsT?ZodTemplateLiteral<Template> :$ZodBranded<ZodTemplateLiteral<Template>,T,Dir>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:25
Type Parameters
T
T extends PropertyKey = PropertyKey
Dir
Dir extends "out" | "in" | "inout" = "out"
Parameters
value?
T
Returns
PropertyKey extends T ? ZodTemplateLiteral<Template> : $ZodBranded<ZodTemplateLiteral<Template>, T, Dir>
Inherited from
catch()
Call Signature
catch(
def):ZodCatch<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:57
Parameters
def
Template
Returns
ZodCatch<ZodTemplateLiteral<Template>>
Inherited from
Call Signature
catch(
def):ZodCatch<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:58
Parameters
def
(ctx) => Template
Returns
ZodCatch<ZodTemplateLiteral<Template>>
Inherited from
check()
check(...
checks):this
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:19
Parameters
checks
...(CheckFn<Template> | $ZodCheck<Template>)[]
Returns
this
Inherited from
clone()
clone(
def?,params?):this
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:21
Parameters
def?
params?
parent
boolean
Returns
this
Inherited from
decode()
decode(
data,params?):Template
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:34
Parameters
data
Template
params?
Returns
Template
Inherited from
decodeAsync()
decodeAsync(
data,params?):Promise<Template>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:36
Parameters
data
Template
params?
Returns
Promise<Template>
Inherited from
default()
Call Signature
default(
def):ZodDefault<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:49
Parameters
def
NoUndefined<Template>
Returns
ZodDefault<ZodTemplateLiteral<Template>>
Inherited from
Call Signature
default(
def):ZodDefault<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:50
Parameters
def
() => NoUndefined<Template>
Returns
ZodDefault<ZodTemplateLiteral<Template>>
Inherited from
describe()
describe(
description):this
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/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
encode()
encode(
data,params?):Template
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:33
Parameters
data
Template
params?
Returns
Template
Inherited from
encodeAsync()
encodeAsync(
data,params?):Promise<Template>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:35
Parameters
data
Template
params?
Returns
Promise<Template>
Inherited from
exactOptional()
exactOptional():
ZodExactOptional<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:45
Returns
ZodExactOptional<ZodTemplateLiteral<Template>>
Inherited from
isNullable()
isNullable():
boolean
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/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
isOptional()
isOptional():
boolean
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/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
meta()
Call Signature
meta(): {[
key:string]:unknown;deprecated?:boolean;description?:string;id?:string;title?:string; } |undefined
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/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
Call Signature
meta(
data):this
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/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
nonoptional()
nonoptional(
params?):ZodNonOptional<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/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<ZodTemplateLiteral<Template>>
Inherited from
nullable()
nullable():
ZodNullable<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:47
Returns
ZodNullable<ZodTemplateLiteral<Template>>
Inherited from
nullish()
nullish():
ZodOptional<ZodNullable<ZodTemplateLiteral<Template>>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:48
Returns
ZodOptional<ZodNullable<ZodTemplateLiteral<Template>>>
Inherited from
optional()
optional():
ZodOptional<ZodTemplateLiteral<Template>>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:44
Returns
ZodOptional<ZodTemplateLiteral<Template>>
Inherited from
or()
or<
T>(option):ZodUnion<[ZodTemplateLiteral<Template>,T]>
Defined in: packages/agentos/node_modules/.pnpm/zod@4.6.5/node_modules/zod/v4/classic/schemas.d.cts:54