Features
Docs
CLI
Benchmarks
Examples
GitHub

© 2024 MoroJs

@morojs/moro

@morojs/moro / z / ZodBigInt

Interface: ZodBigInt

Defined in: node_modules/zod/v4/classic/schemas.d.cts:348

Extends

Extended by

Properties

~~_def~~

_def: $ZodBigIntDef

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

Deprecated

Use .def instead.

Inherited from

_ZodBigInt._def

~~_input~~

_input: bigint

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

Deprecated

Use z.input<typeof schema> instead.

Inherited from

_ZodBigInt._input

~~_output~~

_output: bigint

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

Deprecated

Use z.output<typeof schema> instead.

Inherited from

_ZodBigInt._output

_zod

_zod: $ZodBigIntInternals

Defined in: node_modules/zod/v4/core/schemas.d.cts:89

Inherited from

_ZodBigInt._zod

~standard

~standard: $ZodStandardSchema<ZodBigInt>

Defined in: node_modules/zod/v4/core/schemas.d.cts:90

Inherited from

_ZodBigInt.~standard

def

def: $ZodBigIntDef

Defined in: node_modules/zod/v4/classic/schemas.d.cts:5

Inherited from

_ZodBigInt.def

description?

optional description: string

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

Inherited from

_ZodBigInt.description

format

format: null | string

Defined in: node_modules/zod/v4/classic/schemas.d.cts:346

Inherited from

_ZodBigInt.format

maxValue

maxValue: null | bigint

Defined in: node_modules/zod/v4/classic/schemas.d.cts:345

Inherited from

_ZodBigInt.maxValue

minValue

minValue: null | bigint

Defined in: node_modules/zod/v4/classic/schemas.d.cts:344

Inherited from

_ZodBigInt.minValue

spa()

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

Defined in: node_modules/zod/v4/classic/schemas.d.cts:23

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

_ZodBigInt.spa

type

type: "bigint"

Defined in: node_modules/zod/v4/classic/schemas.d.cts:6

Inherited from

_ZodBigInt.type

Methods

and()

and<T>(incoming): ZodIntersection<ZodBigInt, T>

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

Type Parameters

T

T extends SomeType

Parameters

incoming

T

Returns

ZodIntersection<ZodBigInt, T>

Inherited from

_ZodBigInt.and

array()

array(): ZodArray<ZodBigInt>

Defined in: node_modules/zod/v4/classic/schemas.d.cts:43

Returns

ZodArray<ZodBigInt>

Inherited from

_ZodBigInt.array

brand()

brand<T>(value?): PropertyKey extends T ? ZodBigInt : $ZodBranded<ZodBigInt, T>

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

Type Parameters

T

T extends PropertyKey = PropertyKey

Parameters

value?

T

Returns

PropertyKey extends T ? ZodBigInt : $ZodBranded<ZodBigInt, T>

Inherited from

_ZodBigInt.brand

catch()

Call Signature

catch(def): ZodCatch<ZodBigInt>

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

Parameters
def

bigint

Returns

ZodCatch<ZodBigInt>

Inherited from

_ZodBigInt.catch

Call Signature

catch(def): ZodCatch<ZodBigInt>

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

Parameters
def

(ctx) => bigint

Returns

ZodCatch<ZodBigInt>

Inherited from

_ZodBigInt.catch

check()

check(...checks): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:13

Parameters

checks

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

Returns

this

Inherited from

_ZodBigInt.check

clone()

clone(def?, params?): this

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

Parameters

def?

$ZodBigIntDef

params?
parent

boolean

Returns

this

Inherited from

_ZodBigInt.clone

decode()

decode(data, params?): bigint

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

bigint

Inherited from

_ZodBigInt.decode

decodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<bigint>

Inherited from

_ZodBigInt.decodeAsync

default()

Call Signature

default(def): ZodDefault<ZodBigInt>

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

Parameters
def

bigint

Returns

ZodDefault<ZodBigInt>

Inherited from

_ZodBigInt.default

Call Signature

default(def): ZodDefault<ZodBigInt>

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

Parameters
def

() => bigint

Returns

ZodDefault<ZodBigInt>

Inherited from

_ZodBigInt.default

describe()

describe(description): this

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

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: node_modules/zod/v4/classic/schemas.d.cts:24

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

bigint

Inherited from

_ZodBigInt.encode

encodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<bigint>

Inherited from

_ZodBigInt.encodeAsync

gt()

gt(value, params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:334

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: node_modules/zod/v4/classic/schemas.d.cts:331

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: node_modules/zod/v4/classic/schemas.d.cts:74

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: node_modules/zod/v4/classic/schemas.d.cts:65

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: node_modules/zod/v4/classic/schemas.d.cts:338

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: node_modules/zod/v4/classic/schemas.d.cts:336

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: node_modules/zod/v4/classic/schemas.d.cts:337

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(): undefined | {[key: string]: unknown; deprecated?: boolean; description?: string; id?: string; title?: string; }

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

Returns the metadata associated with this instance in z.globalRegistry

Returns

undefined | {[key: string]: unknown; deprecated?: boolean; description?: string; id?: string; title?: string; }

Inherited from

_ZodBigInt.meta

Call Signature

meta(data): this

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

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: node_modules/zod/v4/classic/schemas.d.cts:333

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: node_modules/zod/v4/classic/schemas.d.cts:343

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: node_modules/zod/v4/classic/schemas.d.cts:340

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: node_modules/zod/v4/classic/schemas.d.cts:342

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

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

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

Inherited from

_ZodBigInt.nonoptional

nonpositive()

nonpositive(params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:341

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

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

Returns

ZodNullable<ZodBigInt>

Inherited from

_ZodBigInt.nullable

nullish()

nullish(): ZodOptional<ZodNullable<ZodBigInt>>

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

Returns

ZodOptional<ZodNullable<ZodBigInt>>

Inherited from

_ZodBigInt.nullish

optional()

optional(): ZodOptional<ZodBigInt>

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

Returns

ZodOptional<ZodBigInt>

Inherited from

_ZodBigInt.optional

or()

or<T>(option): ZodUnion<[ZodBigInt, T]>

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

Type Parameters

T

T extends SomeType

Parameters

option

T

Returns

ZodUnion<[ZodBigInt, T]>

Inherited from

_ZodBigInt.or

overwrite()

overwrite(fn): this

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

Parameters

fn

(x) => bigint

Returns

this

Inherited from

_ZodBigInt.overwrite

parse()

parse(data, params?): bigint

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

bigint

Inherited from

_ZodBigInt.parse

parseAsync()

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

Defined in: node_modules/zod/v4/classic/schemas.d.cts:21

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<bigint>

Inherited from

_ZodBigInt.parseAsync

pipe()

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

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

Type Parameters

T

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

Parameters

target

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

Returns

ZodPipe<ZodBigInt, T>

Inherited from

_ZodBigInt.pipe

positive()

positive(params?): this

Defined in: node_modules/zod/v4/classic/schemas.d.cts:339

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

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

Parameters
def

() => bigint

Returns

ZodPrefault<ZodBigInt>

Inherited from

_ZodBigInt.prefault

Call Signature

prefault(def): ZodPrefault<ZodBigInt>

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

Parameters
def

bigint

Returns

ZodPrefault<ZodBigInt>

Inherited from

_ZodBigInt.prefault

readonly()

readonly(): ZodReadonly<ZodBigInt>

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

Returns

ZodReadonly<ZodBigInt>

Inherited from

_ZodBigInt.readonly

refine()

refine(check, params?): this

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

Parameters

check

(arg) => unknown

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, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).

Returns

this

Inherited from

_ZodBigInt.refine

register()

register<R>(registry, ...meta): this

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

Type Parameters

R

R extends $ZodRegistry<MetadataType, $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>>

Parameters

registry

R

meta

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

Returns

this

Inherited from

_ZodBigInt.register

safeDecode()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<bigint>

Inherited from

_ZodBigInt.safeDecode

safeDecodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

_ZodBigInt.safeDecodeAsync

safeEncode()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<bigint>

Inherited from

_ZodBigInt.safeEncode

safeEncodeAsync()

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

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

Parameters

data

bigint

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

_ZodBigInt.safeEncodeAsync

safeParse()

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

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

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

ZodSafeParseResult<bigint>

Inherited from

_ZodBigInt.safeParse

safeParseAsync()

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

Defined in: node_modules/zod/v4/classic/schemas.d.cts:22

Parameters

data

unknown

params?

ParseContext<$ZodIssue>

Returns

Promise<ZodSafeParseResult<bigint>>

Inherited from

_ZodBigInt.safeParseAsync

superRefine()

superRefine(refinement): this

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

Parameters

refinement

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

Returns

this

Inherited from

_ZodBigInt.superRefine

transform()

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

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

Type Parameters

NewOut

NewOut

Parameters

transform

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

Returns

ZodPipe<ZodBigInt, ZodTransform<Awaited<NewOut>, bigint>>

Inherited from

_ZodBigInt.transform

Back to ZodBigInt-1View Source