Interface ZodBigInt

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

Hierarchy (View Summary)

_ZodBigInt<$ZodBigIntInternals<bigint>>
- ZodBigInt

Properties

_def

_def: $ZodBigIntDef

Deprecated

Use .def instead.

_input

_input: bigint

Deprecated

Use z.input<typeof schema> instead.

_output

_output: bigint

Deprecated

Use z.output<typeof schema> instead.

`Optional`description

description?: string

format

format: null | string

maxValue

maxValue: null | bigint

minValue

minValue: null | bigint

spa

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

type

type: "bigint"

Methods

and

and<T extends SomeType>(incoming: T): ZodIntersection<ZodBigInt, T>
Type Parameters
- T extends SomeType
Parameters
- incoming: T
Returns ZodIntersection<ZodBigInt, T>
Inherited from _ZodBigInt.and
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:41

array

array(): ZodArray<ZodBigInt>
Returns ZodArray<ZodBigInt>
Inherited from _ZodBigInt.array
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:39

brand

brand<T extends PropertyKey = PropertyKey>(
value?: T,
): PropertyKey extends T ? ZodBigInt : $ZodBranded<ZodBigInt, T>
Type Parameters
- T extends PropertyKey = PropertyKey
Parameters
- Optionalvalue: T
Returns PropertyKey extends T ? ZodBigInt : $ZodBranded<ZodBigInt, T>
Inherited from _ZodBigInt.brand
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:21

catch

catch(def: bigint): ZodCatch<ZodBigInt>
Parameters
- def: bigint
Returns ZodCatch<ZodBigInt>
Inherited from _ZodBigInt.catch
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:43
catch(def: (ctx: $ZodCatchCtx) => bigint): ZodCatch<ZodBigInt>
Parameters
- def: (ctx: $ZodCatchCtx) => bigint
Returns ZodCatch<ZodBigInt>
Inherited from _ZodBigInt.catch
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:44

check

check(...checks: ($ZodCheck<bigint> | CheckFn<bigint>)[]): this
Parameters
- ...checks: ($ZodCheck<bigint> | CheckFn<bigint>)[]
Returns this
Inherited from _ZodBigInt.check
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:16

clone

clone(def?: $ZodBigIntDef, params?: { parent: boolean }): this
Parameters
- Optionaldef: $ZodBigIntDef
- Optionalparams: { parent: boolean }
Returns this
Inherited from _ZodBigInt.clone
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:17

default

default(def: bigint): ZodDefault<ZodBigInt>
Parameters
- def: bigint
Returns ZodDefault<ZodBigInt>
Inherited from _ZodBigInt.default
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:35
default(def: () => bigint): ZodDefault<ZodBigInt>
Parameters
- def: () => bigint
Returns ZodDefault<ZodBigInt>
Inherited from _ZodBigInt.default
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:36

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:48

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:318

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:315

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:70

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:61

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:322

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:320

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:321

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:317

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:327

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:324

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:326

nonoptional

nonoptional(
    params?:
        | string
        | {
            error?: string
            | $ZodErrorMap<$ZodIssueInvalidType<unknown>>;
            message?: string;
        },
): ZodNonOptional<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 ZodNonOptional<ZodBigInt>
Inherited from _ZodBigInt.nonoptional
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:32

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:325

nullable

nullable(): ZodNullable<ZodBigInt>
Returns ZodNullable<ZodBigInt>
Inherited from _ZodBigInt.nullable
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:33

nullish

nullish(): ZodOptional<ZodNullable<ZodBigInt>>
Returns ZodOptional<ZodNullable<ZodBigInt>>
Inherited from _ZodBigInt.nullish
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:34

optional

optional(): ZodOptional<ZodBigInt>
Returns ZodOptional<ZodBigInt>
Inherited from _ZodBigInt.optional
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:31

or

or<T extends SomeType>(option: T): ZodUnion<[ZodBigInt, T]>
Type Parameters
- T extends SomeType
Parameters
- option: T
Returns ZodUnion<[ZodBigInt, T]>
Inherited from _ZodBigInt.or
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:40

overwrite

overwrite(fn: (x: bigint) => bigint): this
Parameters
- fn: (x: bigint) => bigint
Returns this
Inherited from _ZodBigInt.overwrite
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:30

parse

parse(data: unknown, params?: ParseContext<$ZodIssue>): bigint
Parameters
- data: unknown
- Optionalparams: ParseContext<$ZodIssue>
Returns bigint
Inherited from _ZodBigInt.parse
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:22

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:24

pipe

pipe<T extends $ZodType<any, bigint, $ZodTypeInternals<any, bigint>>>(
target: T | $ZodType<any, bigint, $ZodTypeInternals<any, bigint>>,
): ZodPipe<ZodBigInt, T>
Type Parameters
- 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
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:45

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:323

prefault

prefault(def: () => bigint): ZodPrefault<ZodBigInt>
Parameters
- def: () => bigint
Returns ZodPrefault<ZodBigInt>
Inherited from _ZodBigInt.prefault
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:37
prefault(def: bigint): ZodPrefault<ZodBigInt>
Parameters
- def: bigint
Returns ZodPrefault<ZodBigInt>
Inherited from _ZodBigInt.prefault
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:38

readonly

readonly(): ZodReadonly<ZodBigInt>
Returns ZodReadonly<ZodBigInt>
Inherited from _ZodBigInt.readonly
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:46

refine

refine(
    check: (arg: bigint) => unknown,
    params?:
        | string
        | {
            abort?: boolean;
            error?: string
            | $ZodErrorMap<NonNullable<$ZodIssue>>;
            message?: string;
            params?: Record<string, any>;
            path?: PropertyKey[];
        },
): this
Parameters
- check: (arg: bigint) => unknown
- Optionalparams:
      | string
      | {
          abort?: boolean;
          error?: string
          | $ZodErrorMap<NonNullable<$ZodIssue>>;
          message?: string;
          params?: Record<string, any>;
          path?: PropertyKey[];
      }
  - string
  - {
        abort?: boolean;
        error?: string | $ZodErrorMap<NonNullable<$ZodIssue>>;
        message?: string;
        params?: Record<string, any>;
        path?: PropertyKey[];
    }
    Optionalabort?: boolean
    If true, no later checks will be executed if this check fails. Default false.
    
    Optionalerror?: string | $ZodErrorMap<NonNullable<$ZodIssue>>
    Optionalmessage?: string
    Deprecated
    This parameter is deprecated. Use error instead.
    
    Optionalparams?: Record<string, any>
    Optionalpath?: PropertyKey[]
Returns this
Inherited from _ZodBigInt.refine
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:27

register

register<
    R extends
        $ZodRegistry<
            MetadataType,
            $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>,
        >,
>(
    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"],
): this
Type Parameters
- 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
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:20

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:23

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/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:25

superRefine

superRefine(
    refinement: (
        arg: bigint,
        ctx: RefinementCtx<bigint>,
    ) => void | Promise<void>,
): this
Parameters
- refinement: (arg: bigint, ctx: RefinementCtx<bigint>) => void | Promise<void>
Returns this
Deprecated
Use .check() instead.
Inherited from _ZodBigInt.superRefine
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:29

transform

transform<NewOut>(
    transform: (
        arg: bigint,
        ctx: RefinementCtx<bigint>,
    ) => NewOut | Promise<NewOut>,
): ZodPipe<ZodBigInt, ZodTransform<Awaited<NewOut>, bigint>>
Type Parameters
- NewOut
Parameters
- transform: (arg: bigint, ctx: RefinementCtx<bigint>) => NewOut | Promise<NewOut>
Returns ZodPipe<ZodBigInt, ZodTransform<Awaited<NewOut>, bigint>>
Inherited from _ZodBigInt.transform
- Defined in node_modules/.pnpm/zod@3.25.67/node_modules/zod/dist/types/v4/classic/schemas.d.ts:42

Interface ZodBigInt

Hierarchy (View Summary)

Index

Properties

Methods

Properties

_def

Deprecated

_input

Deprecated

_output

Deprecated

_zod

~standard

def

Optionaldescription

format

maxValue

minValue

spa

type

Methods

and

Type Parameters

Parameters

Returns ZodIntersection<ZodBigInt, T>

array

Returns ZodArray<ZodBigInt>

brand

Type Parameters

Parameters

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

catch

Parameters

Returns ZodCatch<ZodBigInt>

Parameters

Returns ZodCatch<ZodBigInt>

check

Parameters

Returns this

clone

Parameters

Returns this

default

Parameters

Returns ZodDefault<ZodBigInt>

Parameters

Returns ZodDefault<ZodBigInt>

describe

Parameters

Returns this

gt

Parameters

Optionalabort?: boolean

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

Optionalmessage?: string

Deprecated

Returns this

gte

Parameters

Optionalabort?: boolean

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

Optionalmessage?: string

Deprecated

Returns this

isNullable

Returns boolean

Deprecated

isOptional

Returns boolean

Deprecated

lt

Parameters

Optionalabort?: boolean

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

Optionalmessage?: string

Deprecated

Returns this

lte

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

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

`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

`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`error?: string | $ZodErrorMap<$ZodIssueInvalidType<unknown>>

`Optional`message?: string

`Optional`abort?: boolean

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

`Optional`message?: string