Interface ZodBigInt

interface ZodBigInt {
    minValue: null | bigint;
    maxValue: null | bigint;
    format: null | string;
    def: $ZodBigIntDef;
    type: "bigint";
    _def: $ZodBigIntDef;
    _output: bigint;
    _input: bigint;
    spa: (
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ) => Promise<ZodSafeParseResult<bigint>>;
    description?: string;
    _zod: $ZodBigIntInternals;
    "~standard": $ZodStandardSchema<z.ZodBigInt>;
    gte(
        value: bigint,
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
            },
    ): this;
    min(
        value: bigint,
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
            },
    ): this;
    gt(
        value: bigint,
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
            },
    ): this;
    lte(
        value: bigint,
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
            },
    ): this;
    max(
        value: bigint,
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
            },
    ): this;
    lt(
        value: bigint,
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
            },
    ): this;
    positive(
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
            },
    ): this;
    negative(
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
            },
    ): this;
    nonpositive(
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
                message?: string;
            },
    ): this;
    nonnegative(
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
                message?: string;
            },
    ): this;
    multipleOf(
        value: bigint,
        params?:
            | string
            | {
                abort?: boolean;
                error?: string
                | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
                message?: string;
            },
    ): this;
    check(...checks: (CheckFn<bigint> | z.core.$ZodCheck<bigint>)[]): this;
    clone(def?: $ZodBigIntDef, params?: { parent: boolean }): this;
    register<
        R extends
            $ZodRegistry<
                MetadataType,
                z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
            >,
    >(
        registry: R,
        ...meta: z.ZodBigInt extends R["_schema"]
            ? undefined extends R["_meta"]
                ? [$replace<R["_meta"], R["_schema"] & z.ZodBigInt>?]
                : [$replace<R["_meta"], R["_schema"] & z.ZodBigInt>]
            : ["Incompatible schema"],
    ): this;
    brand<T extends PropertyKey = PropertyKey>(
        value?: T,
    ): PropertyKey extends T ? z.ZodBigInt : $ZodBranded<z.ZodBigInt, T>;
    parse(data: unknown, params?: ParseContext<$ZodIssue>): bigint;
    safeParse(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<bigint>;
    parseAsync(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): Promise<bigint>;
    safeParseAsync(
        data: unknown,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<bigint>>;
    encode(data: bigint, params?: ParseContext<$ZodIssue>): bigint;
    decode(data: bigint, params?: ParseContext<$ZodIssue>): bigint;
    encodeAsync(
        data: bigint,
        params?: ParseContext<$ZodIssue>,
    ): Promise<bigint>;
    decodeAsync(
        data: bigint,
        params?: ParseContext<$ZodIssue>,
    ): Promise<bigint>;
    safeEncode(
        data: bigint,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<bigint>;
    safeDecode(
        data: bigint,
        params?: ParseContext<$ZodIssue>,
    ): ZodSafeParseResult<bigint>;
    safeEncodeAsync(
        data: bigint,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<bigint>>;
    safeDecodeAsync(
        data: bigint,
        params?: ParseContext<$ZodIssue>,
    ): Promise<ZodSafeParseResult<bigint>>;
    refine(
        check: (arg: bigint) => unknown,
        params?:
            | string
            | {
                abort?: boolean;
                when?: (payload: ParsePayload) => boolean;
                path?: PropertyKey[];
                params?: Record<string, any>;
                error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
                message?: string;
            },
    ): this;
    superRefine(
        refinement: (
            arg: bigint,
            ctx: $RefinementCtx<bigint>,
        ) => void | Promise<void>,
    ): this;
    overwrite(fn: (x: bigint) => bigint): this;
    optional(): z.ZodOptional<z.ZodBigInt>;
    nonoptional(
        params?:
            | string
            | {
                error?: string
                | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
                message?: string;
            },
    ): z.ZodNonOptional<z.ZodBigInt>;
    nullable(): z.ZodNullable<z.ZodBigInt>;
    nullish(): z.ZodOptional<z.ZodNullable<z.ZodBigInt>>;
    default(def: bigint): z.ZodDefault<z.ZodBigInt>;
    default(def: () => bigint): z.ZodDefault<z.ZodBigInt>;
    prefault(def: () => bigint): z.ZodPrefault<z.ZodBigInt>;
    prefault(def: bigint): z.ZodPrefault<z.ZodBigInt>;
    array(): z.ZodArray<z.ZodBigInt>;
    or<T extends SomeType>(option: T): z.ZodUnion<[z.ZodBigInt, T]>;
    and<T extends SomeType>(incoming: T): z.ZodIntersection<z.ZodBigInt, T>;
    transform<NewOut>(
        transform: (
            arg: bigint,
            ctx: $RefinementCtx<bigint>,
        ) => NewOut | Promise<NewOut>,
    ): z.ZodPipe<z.ZodBigInt, z.ZodTransform<Awaited<NewOut>, bigint>>;
    catch(def: bigint): z.ZodCatch<z.ZodBigInt>;
    catch(def: (ctx: $ZodCatchCtx) => bigint): z.ZodCatch<z.ZodBigInt>;
    pipe<
        T extends z.core.$ZodType<any, bigint, $ZodTypeInternals<any, bigint>>,
    >(
        target:
            | T
            | z.core.$ZodType<any, bigint, $ZodTypeInternals<any, bigint>>,
    ): z.ZodPipe<z.ZodBigInt, T>;
    readonly(): z.ZodReadonly<z.ZodBigInt>;
    describe(description: string): this;
    meta(): | undefined
    | {
        id?: string;
        title?: string;
        description?: string;
        deprecated?: boolean;
        [key: string]: unknown;
    };
    meta(
        data: {
            id?: string;
            title?: string;
            description?: string;
            deprecated?: boolean;
            [key: string]: unknown;
        },
    ): this;
    isOptional(): boolean;
    isNullable(): boolean;
}

Hierarchy (View Summary)

_ZodBigInt<$ZodBigIntInternals<bigint>>
- ZodBigInt
  - z.ZodBigIntFormat

Properties

minValue

minValue: null | bigint

maxValue

maxValue: null | bigint

format

format: null | string

def

def: $ZodBigIntDef

type

type: "bigint"

_def

_def: $ZodBigIntDef

Deprecated

Use .def instead.

_output

_output: bigint

Deprecated

Use z.output<typeof schema> instead.

_input

_input: bigint

Deprecated

Use z.input<typeof schema> instead.

spa

spa: (
data: unknown,
params?: ParseContext<$ZodIssue>,
) => Promise<ZodSafeParseResult<bigint>>

`Optional`description

description?: string

_zod

_zod: $ZodBigIntInternals

~standard

"~standard": $ZodStandardSchema<z.ZodBigInt>

Methods

gte

gte(
    value: bigint,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
        },
): this
Parameters
- value: bigint
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.gte
- Defined in node_modules/zod/v4/classic/schemas.d.cts:331

min

min(
    value: bigint,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
        },
): this
Alias of .gte()
Parameters
- value: bigint
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.min
- Defined in node_modules/zod/v4/classic/schemas.d.cts:333

gt

gt(
    value: bigint,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
        },
): this
Parameters
- value: bigint
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.gt
- Defined in node_modules/zod/v4/classic/schemas.d.cts:334

lte

lte(
    value: bigint,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
        },
): this
Alias of .lte()
Parameters
- value: bigint
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.lte
- Defined in node_modules/zod/v4/classic/schemas.d.cts:336

max

max(
    value: bigint,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
        },
): this
Parameters
- value: bigint
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.max
- Defined in node_modules/zod/v4/classic/schemas.d.cts:337

lt

lt(
    value: bigint,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
        },
): this
Parameters
- value: bigint
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.lt
- Defined in node_modules/zod/v4/classic/schemas.d.cts:338

positive

positive(
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.positive
- Defined in node_modules/zod/v4/classic/schemas.d.cts:339

negative

negative(
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.negative
- Defined in node_modules/zod/v4/classic/schemas.d.cts:340

nonpositive

nonpositive(
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
            message?: string;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.nonpositive
- Defined in node_modules/zod/v4/classic/schemas.d.cts:341

nonnegative

nonnegative(
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
            message?: string;
        },
): this
Parameters
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.nonnegative
- Defined in node_modules/zod/v4/classic/schemas.d.cts:342

multipleOf

multipleOf(
    value: bigint,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
            message?: string;
        },
): this
Parameters
- value: bigint
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.multipleOf
- Defined in node_modules/zod/v4/classic/schemas.d.cts:343

check

check(...checks: (CheckFn<bigint> | z.core.$ZodCheck<bigint>)[]): this
Parameters
- ...checks: (CheckFn<bigint> | z.core.$ZodCheck<bigint>)[]
Returns this
Inherited from _ZodBigInt.check
- Defined in node_modules/zod/v4/classic/schemas.d.cts:13

clone

clone(def?: $ZodBigIntDef, params?: { parent: boolean }): this
Parameters
- Optionaldef: $ZodBigIntDef
- Optionalparams: { parent: boolean }
Returns this
Inherited from _ZodBigInt.clone
- Defined in node_modules/zod/v4/classic/schemas.d.cts:14

register

register<
    R extends
        $ZodRegistry<
            MetadataType,
            z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >,
>(
    registry: R,
    ...meta: z.ZodBigInt extends R["_schema"]
        ? undefined extends R["_meta"]
            ? [$replace<R["_meta"], R["_schema"] & z.ZodBigInt>?]
            : [$replace<R["_meta"], R["_schema"] & z.ZodBigInt>]
        : ["Incompatible schema"],
): this
Type Parameters
- R extends $ZodRegistry<
  MetadataType,
  z.core.$ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
  >
Parameters
- registry: R
- ...meta: z.ZodBigInt extends R["_schema"]
      ? undefined extends R["_meta"]
          ? [$replace<R["_meta"], R["_schema"] & z.ZodBigInt>?]
          : [$replace<R["_meta"], R["_schema"] & z.ZodBigInt>]
      : ["Incompatible schema"]
Returns this
Inherited from _ZodBigInt.register
- Defined in node_modules/zod/v4/classic/schemas.d.cts:17

brand

brand<T extends PropertyKey = PropertyKey>(
value?: T,
): PropertyKey extends T ? z.ZodBigInt : $ZodBranded<z.ZodBigInt, T>
Type Parameters
- T extends PropertyKey = PropertyKey
Parameters
- Optionalvalue: T
Returns PropertyKey extends T ? z.ZodBigInt : $ZodBranded<z.ZodBigInt, T>
Inherited from _ZodBigInt.brand
- Defined in node_modules/zod/v4/classic/schemas.d.cts:18

parse

parse(data: unknown, params?: ParseContext<$ZodIssue>): bigint
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns bigint
Inherited from _ZodBigInt.parse
- Defined in node_modules/zod/v4/classic/schemas.d.cts:19

safeParse

safeParse(
data: unknown,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<bigint>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<bigint>
Inherited from _ZodBigInt.safeParse
- Defined in node_modules/zod/v4/classic/schemas.d.cts:20

parseAsync

parseAsync(data: unknown, params?: ParseContext<$ZodIssue>): Promise<bigint>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<bigint>
Inherited from _ZodBigInt.parseAsync
- Defined in node_modules/zod/v4/classic/schemas.d.cts:21

safeParseAsync

safeParseAsync(
data: unknown,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<bigint>>
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<bigint>>
Inherited from _ZodBigInt.safeParseAsync
- Defined in node_modules/zod/v4/classic/schemas.d.cts:22

encode

encode(data: bigint, params?: ParseContext<$ZodIssue>): bigint
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns bigint
Inherited from _ZodBigInt.encode
- Defined in node_modules/zod/v4/classic/schemas.d.cts:24

decode

decode(data: bigint, params?: ParseContext<$ZodIssue>): bigint
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns bigint
Inherited from _ZodBigInt.decode
- Defined in node_modules/zod/v4/classic/schemas.d.cts:25

encodeAsync

encodeAsync(data: bigint, params?: ParseContext<$ZodIssue>): Promise<bigint>
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<bigint>
Inherited from _ZodBigInt.encodeAsync
- Defined in node_modules/zod/v4/classic/schemas.d.cts:26

decodeAsync

decodeAsync(data: bigint, params?: ParseContext<$ZodIssue>): Promise<bigint>
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<bigint>
Inherited from _ZodBigInt.decodeAsync
- Defined in node_modules/zod/v4/classic/schemas.d.cts:27

safeEncode

safeEncode(
data: bigint,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<bigint>
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<bigint>
Inherited from _ZodBigInt.safeEncode
- Defined in node_modules/zod/v4/classic/schemas.d.cts:28

safeDecode

safeDecode(
data: bigint,
params?: ParseContext<$ZodIssue>,
): ZodSafeParseResult<bigint>
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns ZodSafeParseResult<bigint>
Inherited from _ZodBigInt.safeDecode
- Defined in node_modules/zod/v4/classic/schemas.d.cts:29

safeEncodeAsync

safeEncodeAsync(
data: bigint,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<bigint>>
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<bigint>>
Inherited from _ZodBigInt.safeEncodeAsync
- Defined in node_modules/zod/v4/classic/schemas.d.cts:30

safeDecodeAsync

safeDecodeAsync(
data: bigint,
params?: ParseContext<$ZodIssue>,
): Promise<ZodSafeParseResult<bigint>>
Parameters
- data: bigint
- Optionalparams: ParseContext<$ZodIssue>
Returns Promise<ZodSafeParseResult<bigint>>
Inherited from _ZodBigInt.safeDecodeAsync
- Defined in node_modules/zod/v4/classic/schemas.d.cts:31

refine

refine(
    check: (arg: bigint) => unknown,
    params?:
        | string
        | {
            abort?: boolean;
            when?: (payload: ParsePayload) => boolean;
            path?: PropertyKey[];
            params?: Record<string, any>;
            error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
            message?: string;
        },
): this
Parameters
- check: (arg: bigint) => unknown
- Optionalparams:
      | string
      | {
          abort?: boolean;
          when?: (payload: ParsePayload) => boolean;
          path?: PropertyKey[];
          params?: Record<string, any>;
          error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
          message?: string;
      }
  - string
  - {
        abort?: boolean;
        when?: (payload: ParsePayload) => boolean;
        path?: PropertyKey[];
        params?: Record<string, any>;
        error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
        message?: string;
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalwhen?: (payload: ParsePayload) => boolean
    If provided, this check will only be executed if the function returns true. Defaults to payload => z.util.isAborted(payload).
    
    Optionalpath?: PropertyKey[]
    Optionalparams?: Record<string, any>
    Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns this
Inherited from _ZodBigInt.refine
- Defined in node_modules/zod/v4/classic/schemas.d.cts:32

superRefine

superRefine(
    refinement: (
        arg: bigint,
        ctx: $RefinementCtx<bigint>,
    ) => void | Promise<void>,
): this
Parameters
- refinement: (arg: bigint, ctx: $RefinementCtx<bigint>) => void | Promise<void>
Returns this
Inherited from _ZodBigInt.superRefine
- Defined in node_modules/zod/v4/classic/schemas.d.cts:33

overwrite

overwrite(fn: (x: bigint) => bigint): this
Parameters
- fn: (x: bigint) => bigint
Returns this
Inherited from _ZodBigInt.overwrite
- Defined in node_modules/zod/v4/classic/schemas.d.cts:34

optional

optional(): z.ZodOptional<z.ZodBigInt>
Returns z.ZodOptional<z.ZodBigInt>
Inherited from _ZodBigInt.optional
- Defined in node_modules/zod/v4/classic/schemas.d.cts:35

nonoptional

nonoptional(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        },
): z.ZodNonOptional<z.ZodBigInt>
Parameters
- Optionalparams:
      | string
      | {
          error?: string
          | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
          message?: string;
      }
  - string
  - {
    error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
    message?: string;
    }
    Optionalerror?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
Returns z.ZodNonOptional<z.ZodBigInt>
Inherited from _ZodBigInt.nonoptional
- Defined in node_modules/zod/v4/classic/schemas.d.cts:36

nullable

nullable(): z.ZodNullable<z.ZodBigInt>
Returns z.ZodNullable<z.ZodBigInt>
Inherited from _ZodBigInt.nullable
- Defined in node_modules/zod/v4/classic/schemas.d.cts:37

nullish

nullish(): z.ZodOptional<z.ZodNullable<z.ZodBigInt>>
Returns z.ZodOptional<z.ZodNullable<z.ZodBigInt>>
Inherited from _ZodBigInt.nullish
- Defined in node_modules/zod/v4/classic/schemas.d.cts:38

default

default(def: bigint): z.ZodDefault<z.ZodBigInt>
Parameters
- def: bigint
Returns z.ZodDefault<z.ZodBigInt>
Inherited from _ZodBigInt.default
- Defined in node_modules/zod/v4/classic/schemas.d.cts:39
default(def: () => bigint): z.ZodDefault<z.ZodBigInt>
Parameters
- def: () => bigint
Returns z.ZodDefault<z.ZodBigInt>
Inherited from _ZodBigInt.default
- Defined in node_modules/zod/v4/classic/schemas.d.cts:40

prefault

prefault(def: () => bigint): z.ZodPrefault<z.ZodBigInt>
Parameters
- def: () => bigint
Returns z.ZodPrefault<z.ZodBigInt>
Inherited from _ZodBigInt.prefault
- Defined in node_modules/zod/v4/classic/schemas.d.cts:41
prefault(def: bigint): z.ZodPrefault<z.ZodBigInt>
Parameters
- def: bigint
Returns z.ZodPrefault<z.ZodBigInt>
Inherited from _ZodBigInt.prefault
- Defined in node_modules/zod/v4/classic/schemas.d.cts:42

array

array(): z.ZodArray<z.ZodBigInt>
Returns z.ZodArray<z.ZodBigInt>
Inherited from _ZodBigInt.array
- Defined in node_modules/zod/v4/classic/schemas.d.cts:43

or

or<T extends SomeType>(option: T): z.ZodUnion<[z.ZodBigInt, T]>
Type Parameters
- T extends SomeType
Parameters
- option: T
Returns z.ZodUnion<[z.ZodBigInt, T]>
Inherited from _ZodBigInt.or
- Defined in node_modules/zod/v4/classic/schemas.d.cts:44

and

and<T extends SomeType>(incoming: T): z.ZodIntersection<z.ZodBigInt, T>
Type Parameters
- T extends SomeType
Parameters
- incoming: T
Returns z.ZodIntersection<z.ZodBigInt, T>
Inherited from _ZodBigInt.and
- Defined in node_modules/zod/v4/classic/schemas.d.cts:45

transform

transform<NewOut>(
    transform: (
        arg: bigint,
        ctx: $RefinementCtx<bigint>,
    ) => NewOut | Promise<NewOut>,
): z.ZodPipe<z.ZodBigInt, z.ZodTransform<Awaited<NewOut>, bigint>>
Type Parameters
- NewOut
Parameters
- transform: (arg: bigint, ctx: $RefinementCtx<bigint>) => NewOut | Promise<NewOut>
Returns z.ZodPipe<z.ZodBigInt, z.ZodTransform<Awaited<NewOut>, bigint>>
Inherited from _ZodBigInt.transform
- Defined in node_modules/zod/v4/classic/schemas.d.cts:46

catch

catch(def: bigint): z.ZodCatch<z.ZodBigInt>
Parameters
- def: bigint
Returns z.ZodCatch<z.ZodBigInt>
Inherited from _ZodBigInt.catch
- Defined in node_modules/zod/v4/classic/schemas.d.cts:47
catch(def: (ctx: $ZodCatchCtx) => bigint): z.ZodCatch<z.ZodBigInt>
Parameters
- def: (ctx: $ZodCatchCtx) => bigint
Returns z.ZodCatch<z.ZodBigInt>
Inherited from _ZodBigInt.catch
- Defined in node_modules/zod/v4/classic/schemas.d.cts:48

pipe

pipe<T extends z.core.$ZodType<any, bigint, $ZodTypeInternals<any, bigint>>>(
target: T | z.core.$ZodType<any, bigint, $ZodTypeInternals<any, bigint>>,
): z.ZodPipe<z.ZodBigInt, T>
Type Parameters
- T extends z.core.$ZodType<any, bigint, $ZodTypeInternals<any, bigint>>
Parameters
- target: T | z.core.$ZodType<any, bigint, $ZodTypeInternals<any, bigint>>
Returns z.ZodPipe<z.ZodBigInt, T>
Inherited from _ZodBigInt.pipe
- Defined in node_modules/zod/v4/classic/schemas.d.cts:49

readonly

readonly(): z.ZodReadonly<z.ZodBigInt>
Returns z.ZodReadonly<z.ZodBigInt>
Inherited from _ZodBigInt.readonly
- Defined in node_modules/zod/v4/classic/schemas.d.cts:50

describe

describe(description: string): this
Returns a new instance that has been registered in z.globalRegistry with the specified description
Parameters
- description: string
Returns this
Inherited from _ZodBigInt.describe
- Defined in node_modules/zod/v4/classic/schemas.d.cts:52

isOptional

isOptional(): boolean
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
- Defined in node_modules/zod/v4/classic/schemas.d.cts:65

isNullable

isNullable(): boolean
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
- Defined in node_modules/zod/v4/classic/schemas.d.cts:74

Interface ZodBigInt

Hierarchy (View Summary)

Index

Properties

Methods

Properties

minValue

maxValue

format

def

type

_def

Deprecated

_output

Deprecated

_input

Deprecated

spa

Optionaldescription

_zod

~standard

Methods

gte

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

min

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

gt

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

lte

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

max

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

lt

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

positive

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

negative

Parameters

Optionalabort?: boolean

Optionalerror?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

Optionalmessage?: string

Deprecated

Returns this

nonpositive

Parameters

`Optional`description

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooBig<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueTooSmall<Numeric>>

`Optional`message?: string

`Optional`abort?: boolean

`Optional`error?: string | $ZodErrorMap<$ZodIssueNotMultipleOf<number | bigint>>

`Optional`message?: string