Interface: ZodBoolean

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

Extends

_ZodBoolean<$ZodBooleanInternals<boolean>>

Properties

_def

_def: $ZodBooleanDef

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

Deprecated

Use .def instead.

Inherited from

_ZodBoolean._def

_input

_input: boolean

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

Deprecated

Use z.input<typeof schema> instead.

Inherited from

_ZodBoolean._input

_output

_output: boolean

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

Deprecated

Use z.output<typeof schema> instead.

Inherited from

_ZodBoolean._output

_zod

_zod: $ZodBooleanInternals

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

Inherited from

_ZodBoolean._zod

~standard

~standard: ZodStandardSchemaWithJSON<ZodBoolean>

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

Inherited from

_ZodBoolean.~standard

def

def: $ZodBooleanDef

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

Inherited from

_ZodBoolean.def

description?

optional description: string

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

Inherited from

_ZodBoolean.description

spa()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<boolean>>

Inherited from

_ZodBoolean.spa

type

type: "boolean"

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

Inherited from

_ZodBoolean.type

Methods

and()

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

Inherited from

_ZodBoolean.and

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

_ZodBoolean.apply

array()

array(): ZodArray<ZodBoolean>

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

Returns

ZodArray<ZodBoolean>

Inherited from

_ZodBoolean.array

brand()

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

Inherited from

_ZodBoolean.brand

catch()

Call Signature

catch(def): ZodCatch<ZodBoolean>

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

Parameters

def

boolean

Returns

ZodCatch<ZodBoolean>

Inherited from

_ZodBoolean.catch

Call Signature

catch(def): ZodCatch<ZodBoolean>

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

Parameters

def

(ctx) => boolean

Returns

ZodCatch<ZodBoolean>

Inherited from

_ZodBoolean.catch

check()

check(...checks): this

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

Parameters

checks

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

Returns

this

Inherited from

_ZodBoolean.check

clone()

clone(def?, params?): this

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

Parameters

def?

$ZodBooleanDef

params?

parent

boolean

Returns

this

Inherited from

_ZodBoolean.clone

decode()

decode(data, params?): boolean

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

Parameters

data

boolean

params?

ParseContext<$ZodIssue>

Returns

boolean

Inherited from

_ZodBoolean.decode

decodeAsync()

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

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

Parameters

data

boolean

params?

ParseContext<$ZodIssue>

Returns

Promise<boolean>

Inherited from

_ZodBoolean.decodeAsync

default()

Call Signature

default(def): ZodDefault<ZodBoolean>

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

Parameters

def

boolean

Returns

ZodDefault<ZodBoolean>

Inherited from

_ZodBoolean.default

Call Signature

default(def): ZodDefault<ZodBoolean>

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

Parameters

def

() => boolean

Returns

ZodDefault<ZodBoolean>

Inherited from

_ZodBoolean.default

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

_ZodBoolean.describe

encode()

encode(data, params?): boolean

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

Parameters

data

boolean

params?

ParseContext<$ZodIssue>

Returns

boolean

Inherited from

_ZodBoolean.encode

encodeAsync()

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

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

Parameters

data

boolean

params?

ParseContext<$ZodIssue>

Returns

Promise<boolean>

Inherited from

_ZodBoolean.encodeAsync

exactOptional()

exactOptional(): ZodExactOptional<ZodBoolean>

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

Returns

ZodExactOptional<ZodBoolean>

Inherited from

_ZodBoolean.exactOptional

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

_ZodBoolean.isNullable

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

_ZodBoolean.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: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

_ZodBoolean.meta

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

_ZodBoolean.meta

nonoptional()

nonoptional(params?): ZodNonOptional<ZodBoolean>

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<ZodBoolean>

Inherited from

_ZodBoolean.nonoptional

nullable()

nullable(): ZodNullable<ZodBoolean>

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

Returns

ZodNullable<ZodBoolean>

Inherited from

_ZodBoolean.nullable

nullish()

nullish(): ZodOptional<ZodNullable<ZodBoolean>>

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

Returns

ZodOptional<ZodNullable<ZodBoolean>>

Inherited from

_ZodBoolean.nullish

optional()

optional(): ZodOptional<ZodBoolean>

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

Returns

ZodOptional<ZodBoolean>

Inherited from

_ZodBoolean.optional

or()

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

Inherited from

_ZodBoolean.or

overwrite()

overwrite(fn): this

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

Parameters

fn

(x) => boolean

Returns

this

Inherited from

_ZodBoolean.overwrite

parse()

parse(data, params?): boolean

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

boolean

Inherited from

_ZodBoolean.parse

parseAsync()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<boolean>

Inherited from

_ZodBoolean.parseAsync

pipe()

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

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

Type Parameters

T

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

Parameters

target

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

Returns

ZodPipe<ZodBoolean, T>

Inherited from

_ZodBoolean.pipe

prefault()

Call Signature

prefault(def): ZodPrefault<ZodBoolean>

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

Parameters

def

() => boolean

Returns

ZodPrefault<ZodBoolean>

Inherited from

_ZodBoolean.prefault

Call Signature

prefault(def): ZodPrefault<ZodBoolean>

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

Parameters

def

boolean

Returns

ZodPrefault<ZodBoolean>

Inherited from

_ZodBoolean.prefault

readonly()

readonly(): ZodReadonly<ZodBoolean>

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

Returns

ZodReadonly<ZodBoolean>

Inherited from

_ZodBoolean.readonly

refine()

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

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

Inherited from

_ZodBoolean.refine

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

Returns

this

Inherited from

_ZodBoolean.register

safeDecode()

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

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

Parameters

data

boolean

safeDecodeAsync()

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

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

Parameters

data

boolean

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<boolean>>

Inherited from

_ZodBoolean.safeDecodeAsync

safeEncode()

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

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

Parameters

data

boolean

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<boolean>

Inherited from

_ZodBoolean.safeEncode

safeEncodeAsync()

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

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

Parameters

data

boolean

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<boolean>>

Inherited from

_ZodBoolean.safeEncodeAsync

safeParse()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<boolean>

Inherited from

_ZodBoolean.safeParse

safeParseAsync()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<boolean>>

Inherited from

_ZodBoolean.safeParseAsync

superRefine()

superRefine(refinement, params?): this

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

Parameters

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

params?

$ZodSuperRefineParams

Returns

this

Inherited from

_ZodBoolean.superRefine

toJSONSchema()

toJSONSchema(params?): ZodStandardJSONSchemaPayload<ZodBoolean>

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

Converts this schema to a JSON Schema representation.

Parameters

params?

ToJSONSchemaParams

Returns

ZodStandardJSONSchemaPayload<ZodBoolean>

Inherited from

_ZodBoolean.toJSONSchema

transform()

transform<NewOut>(transform): ZodPipe<ZodBoolean, ZodTransform<Awaited<NewOut>, boolean>>

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<ZodBoolean, ZodTransform<Awaited<NewOut>, boolean>>

Inherited from

_ZodBoolean.transform

with()

with(...checks): this

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

Parameters

checks

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

Returns

this

Inherited from

_ZodBoolean.with

Extends​

Properties​

_def​

Deprecated​

Inherited from​

_input​

Deprecated​

Inherited from​

_output​

Deprecated​

Inherited from​

_zod​

Inherited from​

~standard​

Inherited from​

def​

Inherited from​

description?​

Inherited from​

spa()​

Parameters​

data​

params?​

Returns​

Inherited from​

type​

Inherited from​

Methods​

and()​

Type Parameters​

T​

Parameters​

incoming​

Returns​

Inherited from​

apply()​

Type Parameters​

T​

Parameters​

fn​

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

parent​

Returns​

Inherited from​

decode()​

Parameters​

data​

params?​

Extends

Properties

_def

Deprecated

Inherited from

_input

Deprecated

Inherited from

_output

Deprecated

Inherited from

_zod

Inherited from

~standard

Inherited from

def

Inherited from

description?

Inherited from

spa()

Parameters

data

params?

Returns

Inherited from

type

Inherited from

Methods

and()

Type Parameters

T

Parameters

incoming

Returns

Inherited from

apply()

Type Parameters

T

Parameters

fn

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?

parent

Returns

Inherited from

decode()

Parameters

data

params?