Skip to main content

Interface: $ZodXIDDef

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

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​

$ZodStringFormatDef.abort

check​

check: "string_format"

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

Inherited from​

$ZodCheckStringFormatDef.check

checks?​

optional checks: $ZodCheck<string>[]

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

Inherited from​

$ZodStringFormatDef.checks

coerce?​

optional coerce: boolean

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

Inherited from​

$ZodStringFormatDef.coerce

error?​

optional error: $ZodErrorMap<never>

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

Inherited from​

$ZodStringFormatDef.error

format​

format: "xid"

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

Inherited from​

$ZodStringFormatDef.format

pattern?​

optional pattern: RegExp

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

Inherited from​

$ZodStringFormatDef.pattern

type​

type: "string"

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

Inherited from​

$ZodStringFormatDef.type

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​

$ZodStringFormatDef.when