Class BigInt

A BigInt object is a wrapper for a primitive bigint value. bigint values can be numbers too large to be stored as number values.

A bigint literal in code is an integer number with an appended n.

Example:

API Version:

Available from version 22.7.

ConstructorDescription
BigInt()Constructs a BigInt with value 0.
BigInt(BigInt)Constructs a new BigInt using the specified BigInt.
BigInt(String)Constructs a BigInt using the specified value.
MethodDescription
static asIntN(Number, BigInt)Clamps the given BigInt value to a signed integer with a given precision.
static asUintN(Number, BigInt)Clamps the given BigInt value to an unsigned integer with a given precision.
toLocaleString()Converts this BigInt to a String using local number formatting conventions.
toString()A String representation of this BigInt.
toString(Number)Converts the BigInt into a string using the specified radix (base).

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

BigInt()

Constructs a BigInt with value 0.


BigInt(value: BigInt)

Constructs a new BigInt using the specified BigInt.

Parameters:

  • value - the BigInt to use.

BigInt(value: String)

Constructs a BigInt using the specified value.

Beside decimal numbers also binary, octal and hexadecimal numbers are supported:

Parameters:

  • value - the value to use when creating the BigInt.

static asIntN(bits: Number, value: BigInt): BigInt

Clamps the given BigInt value to a signed integer with a given precision.

Parameters:

  • bits - Number of bits required for resulting integer.
  • value - The value to be clamped to the given number of bits.

Returns:

  • The value modulo 2bits, as a signed integer.

static asUintN(bits: Number, value: BigInt): BigInt

Clamps the given BigInt value to an unsigned integer with a given precision.

Parameters:

  • bits - Number of bits required for resulting integer.
  • value - The value to be clamped to the given number of bits.

Returns:

  • The value modulo 2bits, as an unsigned integer.

toLocaleString(): String

Converts this BigInt to a String using local number formatting conventions.

The current implementation actually only returns the same as toString().

Returns:

  • a String using local number formatting conventions.

toString(): String

A String representation of this BigInt.

Returns:

  • a String representation of this BigInt.

toString(radix: Number): String

Converts the BigInt into a string using the specified radix (base).

Parameters:

  • radix - the radix to use.

Returns:

  • a String representation of this BigInt.