Skip to main content

Interface: ZodOptional<T>

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

Extends​

Type Parameters​

T​

T extends SomeType = $ZodType

Properties​

_def​

_def: $ZodOptionalDef<T>

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

Deprecated​

Use .def instead.

Inherited from​

_ZodType._def

_input​

_input: input<T> | undefined

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: output<T> | undefined

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: $ZodOptionalInternals

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

Inherited from​

_ZodType._zod

~standard​

~standard: ZodStandardSchemaWithJSON<ZodOptional<T>>

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

Overrides​

_ZodType.~standard

def​

def: $ZodOptionalDef<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<output<T> | undefined>>

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<output<T> | undefined>>

Inherited from​

_ZodType.spa

type​

type: "optional"

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

Inherited from​

_ZodType.type

Methods​

and()​

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

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

Returns​

ZodArray<ZodOptional<T>>

Inherited from​

_ZodType.array

brand()​

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

Inherited from​

_ZodType.brand

catch()​

Call Signature​

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

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

Parameters​
def​

output<T> | undefined

Returns​

ZodCatch<ZodOptional<T>>

Inherited from​

_ZodType.catch

Call Signature​

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

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

Parameters​
def​

(ctx) => output<T> | undefined

Returns​

ZodCatch<ZodOptional<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<output<T> | undefined> | $ZodCheck<output<T> | undefined>)[]

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?​

$ZodOptionalDef<T>

params?​
parent​

boolean

Returns​

this

Inherited from​

_ZodType.clone

decode()​

decode(data, params?): output<T> | undefined

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

Parameters​

data​

input<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

output<T> | undefined

Inherited from​

_ZodType.decode

decodeAsync()​

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

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

Parameters​

data​

input<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

Promise<output<T> | undefined>

Inherited from​

_ZodType.decodeAsync

default()​

Call Signature​

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

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

Parameters​
def​

NoUndefined<output<T>>

Returns​

ZodDefault<ZodOptional<T>>

Inherited from​

_ZodType.default

Call Signature​

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

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

Parameters​
def​

() => NoUndefined<output<T>>

Returns​

ZodDefault<ZodOptional<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?): input<T> | undefined

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

Parameters​

data​

output<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

input<T> | undefined

Inherited from​

_ZodType.encode

encodeAsync()​

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

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

Parameters​

data​

output<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

Promise<input<T> | undefined>

Inherited from​

_ZodType.encodeAsync

exactOptional()​

exactOptional(): ZodExactOptional<ZodOptional<T>>

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

Returns​

ZodExactOptional<ZodOptional<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<ZodOptional<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<ZodOptional<T>>

Inherited from​

_ZodType.nonoptional

nullable()​

nullable(): ZodNullable<ZodOptional<T>>

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

Returns​

ZodNullable<ZodOptional<T>>

Inherited from​

_ZodType.nullable

nullish()​

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

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

Returns​

ZodOptional<ZodNullable<ZodOptional<T>>>

Inherited from​

_ZodType.nullish

optional()​

optional(): ZodOptional<ZodOptional<T>>

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

Returns​

ZodOptional<ZodOptional<T>>

Inherited from​

_ZodType.optional

or()​

or<T>(option): ZodUnion<[ZodOptional<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<[ZodOptional<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) => output<T> | undefined

Returns​

this

Inherited from​

_ZodType.overwrite

parse()​

parse(data, params?): output<T> | undefined

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

output<T> | undefined

Inherited from​

_ZodType.parse

parseAsync()​

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

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

Promise<output<T> | undefined>

Inherited from​

_ZodType.parseAsync

pipe()​

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

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

Type Parameters​

T​

T extends $ZodType<any, output<T> | undefined, $ZodTypeInternals<any, output<T> | undefined>>

Parameters​

target​

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

Returns​

ZodPipe<ZodOptional<T>, T>

Inherited from​

_ZodType.pipe

prefault()​

Call Signature​

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

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

Parameters​
def​

() => input<T> | undefined

Returns​

ZodPrefault<ZodOptional<T>>

Inherited from​

_ZodType.prefault

Call Signature​

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

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

Parameters​
def​

input<T> | undefined

Returns​

ZodPrefault<ZodOptional<T>>

Inherited from​

_ZodType.prefault

readonly()​

readonly(): ZodReadonly<ZodOptional<T>>

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

Returns​

ZodReadonly<ZodOptional<T>>

Inherited from​

_ZodType.readonly

refine()​

refine<Ch>(check, params?): Ch extends (arg) => arg is R ? ZodOptional<T> & ZodType<R, input<T> | undefined, $ZodTypeInternals<R, input<T> | undefined>> : ZodOptional<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 ? ZodOptional<T> & ZodType<R, input<T> | undefined, $ZodTypeInternals<R, input<T> | undefined>> : ZodOptional<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

meta​

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

Returns​

this

Inherited from​

_ZodType.register

safeDecode()​

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

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

Parameters​

data​

input<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

ZodSafeParseResult<output<T> | undefined>

Inherited from​

_ZodType.safeDecode

safeDecodeAsync()​

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

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

Parameters​

data​

input<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<output<T> | undefined>>

Inherited from​

_ZodType.safeDecodeAsync

safeEncode()​

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

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

Parameters​

data​

output<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

ZodSafeParseResult<input<T> | undefined>

Inherited from​

_ZodType.safeEncode

safeEncodeAsync()​

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

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

Parameters​

data​

output<T> | undefined

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<input<T> | undefined>>

Inherited from​

_ZodType.safeEncodeAsync

safeParse()​

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

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

ZodSafeParseResult<output<T> | undefined>

Inherited from​

_ZodType.safeParse

safeParseAsync()​

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

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

Promise<ZodSafeParseResult<output<T> | undefined>>

Inherited from​

_ZodType.safeParseAsync

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​

_ZodType.superRefine

toJSONSchema()​

toJSONSchema(params?): ZodStandardJSONSchemaPayload<ZodOptional<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<ZodOptional<T>>

Inherited from​

_ZodType.toJSONSchema

transform()​

transform<NewOut>(transform): ZodPipe<ZodOptional<T>, ZodTransform<Awaited<NewOut>, output<T> | undefined>>

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<ZodOptional<T>, ZodTransform<Awaited<NewOut>, output<T> | undefined>>

Inherited from​

_ZodType.transform

unwrap()​

unwrap(): T

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

Returns​

T

validate()​

validate(data, params?): data is input<T> | undefined

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

Parameters​

data​

unknown

params?​

ParseContext<$ZodIssue>

Returns​

data is input<T> | undefined

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<output<T> | undefined> | $ZodCheck<output<T> | undefined>)[]

Returns​

this

Inherited from​

_ZodType.with