Interface: ZodType<Output, Input, Internals>

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

Extends

$ZodType<Output, Input, Internals>

Extended by

_ZodType

Type Parameters

Output

Output = unknown

Input

Input = unknown

Internals

Internals extends $ZodTypeInternals<Output, Input> = $ZodTypeInternals<Output, Input>

Properties

_def

_def: Internals["def"]

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

Deprecated

Use .def instead.

_input

_input: Internals["input"]

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

Deprecated

Use z.input<typeof schema> instead.

_output

_output: Internals["output"]

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

Deprecated

Use z.output<typeof schema> instead.

_zod

_zod: Internals

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

Inherited from

$ZodType._zod

~standard

~standard: ZodStandardSchemaWithJSON<ZodType<Output, Input, Internals>>

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

Overrides

$ZodType.~standard

def

def: Internals["def"]

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

description?

optional description: string

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

spa()

spa: (data, params?) => Promise<ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>>

type

type: Internals["def"]["type"]

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

Methods

and()

and<T>(incoming): ZodIntersection<ZodType<Output, Input, Internals>, 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<ZodType<Output, Input, Internals>, T>

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

array()

array(): ZodArray<ZodType<Output, Input, Internals>>

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

Returns

ZodArray<ZodType<Output, Input, Internals>>

brand()

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

catch()

Call Signature

catch(def): ZodCatch<ZodType<Output, Input, Internals>>

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

Parameters

def

output<ZodType<Output, Input, Internals>>

Returns

ZodCatch<ZodType<Output, Input, Internals>>

Call Signature

catch(def): ZodCatch<ZodType<Output, Input, Internals>>

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

Parameters

def

(ctx) => output<ZodType<Output, Input, Internals>>

Returns

ZodCatch<ZodType<Output, Input, Internals>>

check()

check(...checks): this

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

Parameters

checks

...(CheckFn<output<ZodType<Output, Input, Internals>>> | $ZodCheck<output<ZodType<Output, Input, Internals>>>)[]

Returns

this

clone()

clone(def?, params?): this

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

Parameters

def?

Internals["def"]

params?

parent

boolean

Returns

this

decode()

decode(data, params?): output<ZodType<Output, Input, Internals>>

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

Parameters

data

input<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

output<ZodType<Output, Input, Internals>>

decodeAsync()

decodeAsync(data, params?): Promise<output<ZodType<Output, Input, Internals>>>

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

Parameters

data

input<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

Promise<output<ZodType<Output, Input, Internals>>>

default()

Call Signature

default(def): ZodDefault<ZodType<Output, Input, Internals>>

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

Parameters

def

NoUndefined<output<ZodType<Output, Input, Internals>>>

Returns

ZodDefault<ZodType<Output, Input, Internals>>

Call Signature

default(def): ZodDefault<ZodType<Output, Input, Internals>>

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

Parameters

def

() => NoUndefined<output<ZodType<Output, Input, Internals>>>

Returns

ZodDefault<ZodType<Output, Input, Internals>>

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

encode()

encode(data, params?): input<ZodType<Output, Input, Internals>>

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

Parameters

data

output<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

input<ZodType<Output, Input, Internals>>

encodeAsync()

encodeAsync(data, params?): Promise<input<ZodType<Output, Input, Internals>>>

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

Parameters

data

output<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

Promise<input<ZodType<Output, Input, Internals>>>

exactOptional()

exactOptional(): ZodExactOptional<ZodType<Output, Input, Internals>>

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

Returns

ZodExactOptional<ZodType<Output, Input, Internals>>

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

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

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

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

nonoptional()

nonoptional(params?): ZodNonOptional<ZodType<Output, Input, Internals>>

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<ZodType<Output, Input, Internals>>

nullable()

nullable(): ZodNullable<ZodType<Output, Input, Internals>>

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

Returns

ZodNullable<ZodType<Output, Input, Internals>>

nullish()

nullish(): ZodOptional<ZodNullable<ZodType<Output, Input, Internals>>>

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

Returns

ZodOptional<ZodNullable<ZodType<Output, Input, Internals>>>

optional()

optional(): ZodOptional<ZodType<Output, Input, Internals>>

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

Returns

ZodOptional<ZodType<Output, Input, Internals>>

or()

or<T>(option): ZodUnion<[ZodType<Output, Input, Internals>, 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<[ZodType<Output, Input, Internals>, T]>

overwrite()

overwrite(fn): this

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

Parameters

fn

(x) => output<ZodType<Output, Input, Internals>>

Returns

this

parse()

parse(data, params?): output<ZodType<Output, Input, Internals>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

output<ZodType<Output, Input, Internals>>

parseAsync()

parseAsync(data, params?): Promise<output<ZodType<Output, Input, Internals>>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<output<ZodType<Output, Input, Internals>>>

pipe()

pipe<T>(target): ZodPipe<ZodType<Output, Input, Internals>, T>

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

Type Parameters

T

T extends $ZodType<any, output<ZodType<Output, Input, Internals>>, $ZodTypeInternals<any, output<ZodType<Output, Input, Internals>>>>

Parameters

target

T | $ZodType<any, output<ZodType<Output, Input, Internals>>, $ZodTypeInternals<any, output<ZodType<Output, Input, Internals>>>>

Returns

ZodPipe<ZodType<Output, Input, Internals>, T>

prefault()

Call Signature

prefault(def): ZodPrefault<ZodType<Output, Input, Internals>>

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

Parameters

def

() => input<ZodType<Output, Input, Internals>>

Returns

ZodPrefault<ZodType<Output, Input, Internals>>

Call Signature

prefault(def): ZodPrefault<ZodType<Output, Input, Internals>>

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

Parameters

def

input<ZodType<Output, Input, Internals>>

Returns

ZodPrefault<ZodType<Output, Input, Internals>>

readonly()

readonly(): ZodReadonly<ZodType<Output, Input, Internals>>

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

Returns

ZodReadonly<ZodType<Output, Input, Internals>>

refine()

refine<Ch>(check, params?): Ch extends (arg) => arg is R ? ZodType<Output, Input, Internals> & ZodType<R, input<ZodType<Output, Input, Internals>>, $ZodTypeInternals<R, input<ZodType<Output, Input, Internals>>>> : ZodType<Output, Input, Internals>

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 ? ZodType<Output, Input, Internals> & ZodType<R, input<ZodType<Output, Input, Internals>>, $ZodTypeInternals<R, input<ZodType<Output, Input, Internals>>>> : ZodType<Output, Input, Internals>

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

safeDecode()

safeDecode(data, params?): ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>

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

Parameters

data

input<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>

safeDecodeAsync()

safeDecodeAsync(data, params?): Promise<ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>>

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

Parameters

data

input<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>>

safeEncode()

safeEncode(data, params?): ZodSafeParseResult<input<ZodType<Output, Input, Internals>>>

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

Parameters

data

output<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<input<ZodType<Output, Input, Internals>>>

safeEncodeAsync()

safeEncodeAsync(data, params?): Promise<ZodSafeParseResult<input<ZodType<Output, Input, Internals>>>>

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

Parameters

data

output<ZodType<Output, Input, Internals>>

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<input<ZodType<Output, Input, Internals>>>>

safeParse()

safeParse(data, params?): ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>

safeParseAsync()

safeParseAsync(data, params?): Promise<ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<output<ZodType<Output, Input, Internals>>>>

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

toJSONSchema()

toJSONSchema(params?): ZodStandardJSONSchemaPayload<ZodType<Output, Input, Internals>>

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<ZodType<Output, Input, Internals>>

transform()

transform<NewOut>(transform): ZodPipe<ZodType<Output, Input, Internals>, ZodTransform<Awaited<NewOut>, output<ZodType<Output, Input, Internals>>>>

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<ZodType<Output, Input, Internals>, ZodTransform<Awaited<NewOut>, output<ZodType<Output, Input, Internals>>>>

validate()

validate(data, params?): data is input<ZodType<Output, Input, Internals>>

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

data is input<ZodType<Output, Input, Internals>>

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>

with()

with(...checks): this

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

Parameters

checks

...(CheckFn<output<ZodType<Output, Input, Internals>>> | $ZodCheck<output<ZodType<Output, Input, Internals>>>)[]

Returns

this

Extends​

Extended by​

Type Parameters​

Output​

Input​

Internals​

Properties​

_def​

Deprecated​

_input​

Deprecated​

_output​

Deprecated​

_zod​

Inherited from​

~standard​

Overrides​

def​

description?​

spa()​

Parameters​

data​

params?​

Returns​

type​

Methods​

and()​

Type Parameters​

T​

Parameters​

incoming​

Returns​

apply()​

Type Parameters​

T​

TArgs​

Parameters​

fn​

args​

Returns​

array()​

Returns​

brand()​

Type Parameters​

T​

Dir​

Parameters​

value?​

Returns​

catch()​

Call Signature​

Parameters​

def​

Returns​

Call Signature​

Parameters​

def​

Returns​

check()​

Parameters​

checks​

Returns​

clone()​

Parameters​

def?​

params?​

parent​

Returns​

decode()​

Parameters​

data​

params?​

Returns​

decodeAsync()​

Parameters​

data​

params?​

Returns​

default()​

Call Signature​

Extends

Extended by

Type Parameters

Output

Input

Internals

Properties

_def

Deprecated

_input

Deprecated

_output

Deprecated

_zod

Inherited from

~standard

Overrides

def

description?

spa()

Parameters

data

params?

Returns

type

Methods

and()

Type Parameters

T

Parameters

incoming

Returns

apply()

Type Parameters

T

TArgs

Parameters

fn

args

Returns

array()

Returns

brand()

Type Parameters

T

Dir

Parameters

value?

Returns

catch()

Call Signature

Parameters

def

Returns

Call Signature

Parameters

def

Returns

check()

Parameters

checks

Returns

clone()

Parameters

def?

params?

parent

Returns

decode()

Parameters

data

params?

Returns

decodeAsync()

Parameters

data

params?

Returns

default()

Call Signature