Interface: ZodLiteral<T>

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

Extends

_ZodType<$ZodLiteralInternals<T>>.$ZodLiteral<T>

Type Parameters

T

T extends Literal = Literal

Properties

_def

_def: $ZodLiteralDef<T>

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

Deprecated

Use .def instead.

Inherited from

_ZodType._def

_input

_input: T

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

Deprecated

Use z.input<typeof schema> instead.

Inherited from

_ZodType._input

_output

_output: T

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

Deprecated

Use z.output<typeof schema> instead.

Inherited from

_ZodType._output

_zod

_zod: $ZodLiteralInternals

Defined in: packages/agentos/node_modules/zod/v4/core/schemas.d.cts:111

Inherited from

_ZodType._zod

~standard

~standard: ZodStandardSchemaWithJSON<ZodLiteral<T>>

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

Overrides

_ZodType.~standard

def

def: $ZodLiteralDef<T>

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

Inherited from

_ZodType.def

description?

optional description: string

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

Inherited from

_ZodType.description

spa()

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

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

Parameters

data

unknown

type

type: "literal"

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

Inherited from

_ZodType.type

value

value: T

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

Legacy

Use .values instead. Accessing this property will throw an error if the literal accepts multiple values.

values

values: Set<T>

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

Methods

and()

and<T>(incoming): ZodIntersection<ZodLiteral<T>, 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<ZodLiteral<T>, T>

Inherited from

_ZodType.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

_ZodType.apply

array()

array(): ZodArray<ZodLiteral<T>>

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

Returns

ZodArray<ZodLiteral<T>>

Inherited from

_ZodType.array

brand()

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

Inherited from

_ZodType.brand

catch()

Call Signature

catch(def): ZodCatch<ZodLiteral<T>>

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

Parameters

def

T

Returns

ZodCatch<ZodLiteral<T>>

Inherited from

_ZodType.catch

Call Signature

catch(def): ZodCatch<ZodLiteral<T>>

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

Parameters

def

(ctx) => T

Returns

ZodCatch<ZodLiteral<T>>

Inherited from

_ZodType.catch

check()

check(...checks): this

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

Parameters

checks

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

Returns

this

Inherited from

_ZodType.check

clone()

clone(def?, params?): this

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

Parameters

def?

$ZodLiteralDef<T>

params?

parent

boolean

Returns

this

Inherited from

_ZodType.clone

decode()

decode(data, params?): T

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

T

Inherited from

_ZodType.decode

decodeAsync()

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

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

Promise<T>

Inherited from

_ZodType.decodeAsync

default()

Call Signature

default(def): ZodDefault<ZodLiteral<T>>

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

Parameters

def

NoUndefined<T>

Returns

ZodDefault<ZodLiteral<T>>

Inherited from

_ZodType.default

Call Signature

default(def): ZodDefault<ZodLiteral<T>>

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

Parameters

def

() => NoUndefined<T>

Returns

ZodDefault<ZodLiteral<T>>

Inherited from

_ZodType.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

_ZodType.describe

encode()

encode(data, params?): T

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

T

Inherited from

_ZodType.encode

encodeAsync()

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

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

Promise<T>

Inherited from

_ZodType.encodeAsync

exactOptional()

exactOptional(): ZodExactOptional<ZodLiteral<T>>

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

Returns

ZodExactOptional<ZodLiteral<T>>

Inherited from

_ZodType.exactOptional

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

_ZodType.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

_ZodType.isOptional

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

_ZodType.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

_ZodType.meta

nonoptional()

nonoptional(params?): ZodNonOptional<ZodLiteral<T>>

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<ZodLiteral<T>>

Inherited from

_ZodType.nonoptional

nullable()

nullable(): ZodNullable<ZodLiteral<T>>

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

Returns

ZodNullable<ZodLiteral<T>>

Inherited from

_ZodType.nullable

nullish()

nullish(): ZodOptional<ZodNullable<ZodLiteral<T>>>

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

Returns

ZodOptional<ZodNullable<ZodLiteral<T>>>

Inherited from

_ZodType.nullish

optional()

optional(): ZodOptional<ZodLiteral<T>>

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

Returns

ZodOptional<ZodLiteral<T>>

Inherited from

_ZodType.optional

or()

or<T>(option): ZodUnion<[ZodLiteral<T>, 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<[ZodLiteral<T>, T]>

Inherited from

_ZodType.or

overwrite()

overwrite(fn): this

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

Parameters

fn

(x) => T

Returns

this

Inherited from

_ZodType.overwrite

parse()

parse(data, params?): T

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

T

Inherited from

_ZodType.parse

parseAsync()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<T>

Inherited from

_ZodType.parseAsync

pipe()

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

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

Type Parameters

T

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

Parameters

target

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

Returns

ZodPipe<ZodLiteral<T>, T>

Inherited from

_ZodType.pipe

prefault()

Call Signature

prefault(def): ZodPrefault<ZodLiteral<T>>

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

Parameters

def

() => T

Returns

ZodPrefault<ZodLiteral<T>>

Inherited from

_ZodType.prefault

Call Signature

prefault(def): ZodPrefault<ZodLiteral<T>>

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

Parameters

def

T

Returns

ZodPrefault<ZodLiteral<T>>

Inherited from

_ZodType.prefault

readonly()

readonly(): ZodReadonly<ZodLiteral<T>>

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

Returns

ZodReadonly<ZodLiteral<T>>

Inherited from

_ZodType.readonly

refine()

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

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 ? ZodLiteral<T> & ZodType<R, T, $ZodTypeInternals<R, T>> : ZodLiteral<T>

Inherited from

_ZodType.refine

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

Returns

this

Inherited from

_ZodType.register

safeDecode()

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

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<T>

Inherited from

_ZodType.safeDecode

safeDecodeAsync()

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

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<T>>

Inherited from

_ZodType.safeDecodeAsync

safeEncode()

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

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<T>

Inherited from

_ZodType.safeEncode

safeEncodeAsync()

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

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

Parameters

data

T

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<T>>

Inherited from

_ZodType.safeEncodeAsync

safeParse()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<T>

Inherited from

_ZodType.safeParse

safeParseAsync()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<T>>

Inherited from

_ZodType.safeParseAsync

superRefine()

superRefine(refinement, params?): this

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

Parameters

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

params?

$ZodSuperRefineParams

Returns

this

Inherited from

_ZodType.superRefine

toJSONSchema()

toJSONSchema(params?): ZodStandardJSONSchemaPayload<ZodLiteral<T>>

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<ZodLiteral<T>>

Inherited from

_ZodType.toJSONSchema

transform()

transform<NewOut>(transform): ZodPipe<ZodLiteral<T>, ZodTransform<Awaited<NewOut>, T>>

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<ZodLiteral<T>, ZodTransform<Awaited<NewOut>, T>>

Inherited from

_ZodType.transform

validate()

validate(data, params?): data is T

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

data is T

Inherited from

_ZodType.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

_ZodType.validateAsync

with()

with(...checks): this

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

Parameters

checks

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

Returns

this

Inherited from

_ZodType.with

Extends​

Type Parameters​

T​

Properties​

_def​

Deprecated​

Inherited from​

_input​

Deprecated​

Inherited from​

_output​

Deprecated​

Inherited from​

_zod​

Inherited from​

~standard​

Overrides​

def​

Inherited from​

description?​

Inherited from​

spa()​

Parameters​

data​

params?​

Returns​

Inherited from​

type​

Inherited from​

value​

Legacy​

values​

Methods​

and()​

Type Parameters​

T​

Parameters​

incoming​

Returns​

Inherited from​

apply()​

Type Parameters​

T​

TArgs​

Parameters​

fn​

args​

Returns​

Inherited from​

array()​

Returns​

Inherited from​

brand()​

Type Parameters​

T​

Dir​

Parameters​

value?​

Returns​

Inherited from​

catch()​

Call Signature​

Parameters​

def​

Returns​

Inherited from​

Call Signature​

Parameters​

def​

Returns​

Inherited from​

check()​

Parameters​

checks​

Returns​

Inherited from​

clone()​

Parameters​

def?​

params?​

Extends

Type Parameters

T

Properties

_def

Deprecated

Inherited from

_input

Deprecated

Inherited from

_output

Deprecated

Inherited from

_zod

Inherited from

~standard

Overrides

def

Inherited from

description?

Inherited from

spa()

Parameters

data

params?

Returns

Inherited from

type

Inherited from

value

Legacy

values

Methods

and()

Type Parameters

T

Parameters

incoming

Returns

Inherited from

apply()

Type Parameters

T

TArgs

Parameters

fn

args

Returns

Inherited from

array()

Returns

Inherited from

brand()

Type Parameters

T

Dir

Parameters

value?

Returns

Inherited from

catch()

Call Signature

Parameters

def

Returns

Inherited from

Call Signature

Parameters

def

Returns

Inherited from

check()

Parameters

checks

Returns

Inherited from

clone()

Parameters

def?

params?