Interface: ZodBigIntFormat

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

Extends

• ZodBigInt

Properties

_def

_def: $ZodBigIntDef

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

Deprecated

Use .def instead.

Inherited from

ZodBigInt._def

---

_input

_input: bigint

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

Deprecated

Use z.input<typeof schema> instead.

Inherited from

ZodBigInt._input

---

_output

_output: bigint

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

Deprecated

Use z.output<typeof schema> instead.

Inherited from

ZodBigInt._output

---

_zod

_zod: $ZodBigIntFormatInternals

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

Overrides

ZodBigInt._zod

---

~standard

~standard: ZodStandardSchemaWithJSON<ZodBigIntFormat>

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

Inherited from

ZodBigInt.~standard

---

def

def: $ZodBigIntDef

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

Inherited from

ZodBigInt.def

---

description?

optional description: string

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

Inherited from

ZodBigInt.description

---

format

format: string | null

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

Inherited from

ZodBigInt.format

---

maxValue

maxValue: bigint | null

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

Inherited from

ZodBigInt.maxValue

---

minValue

minValue: bigint | null

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

Inherited from

ZodBigInt.minValue

---

spa()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

ZodBigInt.spa

---

type

type: "bigint"

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

Inherited from

ZodBigInt.type

Methods

and()

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

Inherited from

ZodBigInt.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

ZodBigInt.apply

---

array()

array(): ZodArray<ZodBigIntFormat>

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

Returns

ZodArray<ZodBigIntFormat>

Inherited from

ZodBigInt.array

---

brand()

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

Inherited from

ZodBigInt.brand

---

catch()

Call Signature

catch(def): ZodCatch<ZodBigIntFormat>

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

Parameters

def

bigint

Returns

ZodCatch<ZodBigIntFormat>

Inherited from

ZodBigInt.catch

Call Signature

catch(def): ZodCatch<ZodBigIntFormat>

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

Parameters

def

(ctx) => bigint

Returns

ZodCatch<ZodBigIntFormat>

Inherited from

ZodBigInt.catch

---

check()

check(...checks): this

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

Parameters

checks

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

Returns

this

Inherited from

ZodBigInt.check

---

clone()

clone(def?, params?): this

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

Parameters

def?

$ZodBigIntDef

params?

parent

boolean

Returns

this

Inherited from

ZodBigInt.clone

---

decode()

decode(data, params?): bigint

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

bigint

Inherited from

ZodBigInt.decode

---

decodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<bigint>

Inherited from

ZodBigInt.decodeAsync

---

default()

Call Signature

default(def): ZodDefault<ZodBigIntFormat>

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

Parameters

def

bigint

Returns

ZodDefault<ZodBigIntFormat>

Inherited from

ZodBigInt.default

Call Signature

default(def): ZodDefault<ZodBigIntFormat>

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

Parameters

def

() => bigint

Returns

ZodDefault<ZodBigIntFormat>

Inherited from

ZodBigInt.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

ZodBigInt.describe

---

encode()

encode(data, params?): bigint

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

bigint

Inherited from

ZodBigInt.encode

---

encodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<bigint>

Inherited from

ZodBigInt.encodeAsync

---

exactOptional()

exactOptional(): ZodExactOptional<ZodBigIntFormat>

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

Returns

ZodExactOptional<ZodBigIntFormat>

Inherited from

ZodBigInt.exactOptional

---

gt()

gt(value, params?): this

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

Parameters

value

bigint

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.gt

---

gte()

gte(value, params?): this

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

Parameters

value

bigint

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.gte

---

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

ZodBigInt.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

ZodBigInt.isOptional

---

lt()

lt(value, params?): this

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

Parameters

value

bigint

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.lt

---

lte()

lte(value, params?): this

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

Alias of .lte()

Parameters

value

bigint

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.lte

---

max()

max(value, params?): this

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

Parameters

value

bigint

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.max

---

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

ZodBigInt.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

ZodBigInt.meta

---

min()

min(value, params?): this

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

Alias of .gte()

Parameters

value

bigint

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.min

---

multipleOf()

multipleOf(value, params?): this

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

Parameters

value

bigint

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.multipleOf

---

negative()

negative(params?): this

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

Parameters

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.negative

---

nonnegative()

nonnegative(params?): this

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

Parameters

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.nonnegative

---

nonoptional()

nonoptional(params?): ZodNonOptional<ZodBigIntFormat>

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

Inherited from

ZodBigInt.nonoptional

---

nonpositive()

nonpositive(params?): this

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

Parameters

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.nonpositive

---

nullable()

nullable(): ZodNullable<ZodBigIntFormat>

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

Returns

ZodNullable<ZodBigIntFormat>

Inherited from

ZodBigInt.nullable

---

nullish()

nullish(): ZodOptional<ZodNullable<ZodBigIntFormat>>

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

Returns

ZodOptional<ZodNullable<ZodBigIntFormat>>

Inherited from

ZodBigInt.nullish

---

optional()

optional(): ZodOptional<ZodBigIntFormat>

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

Returns

ZodOptional<ZodBigIntFormat>

Inherited from

ZodBigInt.optional

---

or()

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

Inherited from

ZodBigInt.or

---

overwrite()

overwrite(fn): this

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

Parameters

fn

(x) => bigint

Returns

this

Inherited from

ZodBigInt.overwrite

---

parse()

parse(data, params?): bigint

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

bigint

Inherited from

ZodBigInt.parse

---

parseAsync()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<bigint>

Inherited from

ZodBigInt.parseAsync

---

pipe()

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

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

Type Parameters

T

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

Parameters

target

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

Returns

ZodPipe<ZodBigIntFormat, T>

Inherited from

ZodBigInt.pipe

---

positive()

positive(params?): this

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

Parameters

params?

string |

{ abort?: boolean; error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>; message?: string; }

abort?

boolean

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

error?

string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

message?

string

Deprecated

This parameter is deprecated. Use error instead.

Returns

this

Inherited from

ZodBigInt.positive

---

prefault()

Call Signature

prefault(def): ZodPrefault<ZodBigIntFormat>

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

Parameters

def

() => bigint

Returns

ZodPrefault<ZodBigIntFormat>

Inherited from

ZodBigInt.prefault

Call Signature

prefault(def): ZodPrefault<ZodBigIntFormat>

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

Parameters

def

bigint

Returns

ZodPrefault<ZodBigIntFormat>

Inherited from

ZodBigInt.prefault

---

readonly()

readonly(): ZodReadonly<ZodBigIntFormat>

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

Returns

ZodReadonly<ZodBigIntFormat>

Inherited from

ZodBigInt.readonly

---

refine()

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

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

Inherited from

ZodBigInt.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

meta

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

Returns

this

Inherited from

ZodBigInt.register

---

safeDecode()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<bigint>

Inherited from

ZodBigInt.safeDecode

---

safeDecodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

ZodBigInt.safeDecodeAsync

---

safeEncode()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<bigint>

Inherited from

ZodBigInt.safeEncode

---

safeEncodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

ZodBigInt.safeEncodeAsync

---

safeParse()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<bigint>

Inherited from

ZodBigInt.safeParse

---

safeParseAsync()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

ZodBigInt.safeParseAsync

---

superRefine()

superRefine(refinement, params?): this

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

Parameters

refinement

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

params?

$ZodSuperRefineParams

Returns

this

Inherited from

ZodBigInt.superRefine

---

toJSONSchema()

toJSONSchema(params?): ZodStandardJSONSchemaPayload<ZodBigIntFormat>

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

Inherited from

ZodBigInt.toJSONSchema

---

transform()

transform<NewOut>(transform): ZodPipe<ZodBigIntFormat, ZodTransform<Awaited<NewOut>, bigint>>

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<ZodBigIntFormat, ZodTransform<Awaited<NewOut>, bigint>>

Inherited from

ZodBigInt.transform

---

with()

with(...checks): this

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

Parameters

checks

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

Returns

this

Inherited from

ZodBigInt.with