Skip to main content

Interface: $ZodCheckPropertyDef

Defined in: packages/agentos/node_modules/zod/v4/core/checks.d.cts:240

Extends

Properties

abort?

optional abort: boolean

Defined in: packages/agentos/node_modules/zod/v4/core/checks.d.cts:9

If true, no later checks will be executed if this check fails. Default false.

Inherited from

$ZodCheckDef.abort


check

check: "property"

Defined in: packages/agentos/node_modules/zod/v4/core/checks.d.cts:241

Overrides

$ZodCheckDef.check


error?

optional error: $ZodErrorMap<never>

Defined in: packages/agentos/node_modules/zod/v4/core/checks.d.cts:7

Inherited from

$ZodCheckDef.error


property

property: string

Defined in: packages/agentos/node_modules/zod/v4/core/checks.d.cts:242


schema

schema: $ZodType

Defined in: packages/agentos/node_modules/zod/v4/core/checks.d.cts:243


when()?

optional when: (payload) => boolean

Defined in: packages/agentos/node_modules/zod/v4/core/checks.d.cts:11

If provided, the check runs only when this returns true. By default, it is skipped if prior parsing produced aborting issues.

Parameters

payload

ParsePayload

Returns

boolean

Inherited from

$ZodCheckDef.when