Class CheckedBigInt

constructor

• new CheckedBigInt(value: bigint, bounds: Bounds): CheckedBigInt

  Creates a new CheckedBigInt. with custom boundaries

  Parameters

  • value: bigint

    initial value
  • bounds: Bounds

    the set boundaries for the instance

  Returns CheckedBigInt

  Example

  const a = new CheckedBigInt(1n, {min: 1n, max: 10n})
  Copy

• new CheckedBigInt(value: bigint, bits: number, signed: boolean): CheckedBigInt

  Creates a new CheckedBigInt. with a specific bit size and signedness

  Parameters

  • value: bigint

    initial value
  • bits: number

    the bit size of the integer
  • signed: boolean

    whether the integer is signed or not

  Returns CheckedBigInt

  Example

  const a = new CheckedBigInt(1n /* value */, 8 /*bits*/, false/*unsigned*/)
  Copy

Readonlyboundaries

Readonlyvalue

add

• add(other: bigint): CheckedBigInt

  Add another integer to this integer, checking for overflow.

  Parameters

  • other: bigint

    The integer to add.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the addition.

  Throws

  RangeError If the result of the addition would exceed the bit size.

  Example

  const a = i8(1n).add(1n) // 2
  const b = i8(127n).add(1n) // throws RangeError
  Copy

and

• and(other: bigint): CheckedBigInt

  Bitwise AND operation.

  Parameters

  • other: bigint

    The integer to AND with.

  Returns CheckedBigInt

  A new CheckedBigInt with the result.

div

• div(other: bigint): CheckedBigInt

  Divide this integer by another integer, checking for overflow.

  Parameters

  • other: bigint

    The integer to divide by.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the division.

  Throws

  RangeError If the result of the division would exceed the bit size.

  Throws

  RangeError If the divisor is zero.

eq

• eq(other: bigint): boolean

  Check equality with another value.

  Parameters

  • other: bigint

    The value to compare with.

  Returns boolean

  true if equal, false otherwise.

gt

• gt(other: bigint): boolean

  Check if this value is greater than another.

  Parameters

  • other: bigint

    The value to compare with.

  Returns boolean

  true if greater than, false otherwise.

gte

• gte(other: bigint): boolean

  Check if this value is greater than or equal to another.

  Parameters

  • other: bigint

    The value to compare with.

  Returns boolean

  true if greater than or equal, false otherwise.

lt

• lt(other: bigint): boolean

  Check if this value is less than another.

  Parameters

  • other: bigint

    The value to compare with.

  Returns boolean

  true if less than, false otherwise.

lte

• lte(other: bigint): boolean

  Check if this value is less than or equal to another.

  Parameters

  • other: bigint

    The value to compare with.

  Returns boolean

  true if less than or equal, false otherwise.

mod

• mod(other: bigint): CheckedBigInt

  Modulo operation (always returns non-negative result for positive divisor). Unlike rem(), mod() follows mathematical modulo semantics where the result has the same sign as the divisor.

  Parameters

  • other: bigint

    The integer to divide by.

  Returns CheckedBigInt

  A new CheckedBigInt with the modulo result.

  Throws

  RangeError If the divisor is zero.

  Example

  i8(-5n).mod(3n)  // 1n (mathematical modulo)
  i8(-5n).rem(3n)  // -2n (remainder)
  Copy

mul

• mul(other: bigint): CheckedBigInt

  Multiply this integer by another integer, checking for overflow.

  Parameters

  • other: bigint

    The integer to multiply by.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the multiplication.

  Throws

  RangeError If the result of the multiplication would exceed the bit size.

neq

• neq(other: bigint): boolean

  Check inequality with another value.

  Parameters

  • other: bigint

    The value to compare with.

  Returns boolean

  true if not equal, false otherwise.

not

• not(): CheckedBigInt

  Bitwise NOT operation (two's complement).

  Returns CheckedBigInt

  A new CheckedBigInt with the bitwise complement.

or

• or(other: bigint): CheckedBigInt

  Bitwise OR operation.

  Parameters

  • other: bigint

    The integer to OR with.

  Returns CheckedBigInt

  A new CheckedBigInt with the result.

pow

• pow(exponent: bigint): CheckedBigInt

  Power this integer to another integer, checking for overflow.

  Parameters

  • exponent: bigint

    The integer to power by.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the power.

  Throws

  RangeError If the exponent is negative.

  Throws

  RangeError If the result of the power would exceed the bit size.

rem

• rem(other: bigint): CheckedBigInt

  Remainder of the division of this integer by another integer, checking for overflow.

  Parameters

  • other: bigint

    The integer to divide by.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the remainder.

  Throws

  RangeError If the result of the remainder would exceed the bit size.

  Throws

  RangeError If the divisor is zero.

shl

• shl(bits: number | bigint): CheckedBigInt

  Bitwise shift left this integer by another integer, checking for overflow.

  Parameters

  • bits: number | bigint

    The integer to shift by.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the shift.

  Throws

  RangeError If the number of bits is negative.

  Throws

  RangeError If the resulting number would exceed the bit size.

shr

• shr(bits: number | bigint): CheckedBigInt

  Bitwise shift right this integer by another integer, checking for overflow.

  Parameters

  • bits: number | bigint

    The integer to shift by.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the shift.

  Throws

  RangeError If the number of bits is negative.

  Throws

  RangeError If bits is greater than the bit size.

sub

• sub(other: bigint): CheckedBigInt

  Subtract another integer from this integer, checking for overflow.

  Parameters

  • other: bigint

    The integer to subtract.

  Returns CheckedBigInt

  A new CheckedBigInt with the result of the subtraction.

  Throws

  RangeError If the result of the subtraction would exceed the bit size.

toJSON

• toJSON(): string

  Returns the value for JSON serialization. Note: BigInt values are converted to strings in JSON.

  Returns string

  The string representation of the value.

toString

• toString(radix?: number): string

  Returns the string representation of the value.

  Parameters

  • Optionalradix: number

    Optional radix for the string representation (default: 10).

  Returns string

  The string representation of the value.

valueOf

• valueOf(): bigint

  Returns the primitive value (for use with valueOf).

  Returns bigint

  The bigint value.

xor

• xor(other: bigint): CheckedBigInt

  Bitwise XOR operation.

  Parameters

  • other: bigint

    The integer to XOR with.

  Returns CheckedBigInt

  A new CheckedBigInt with the result.