Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Long

A class representing a 64-bit integer

remarks

The internal representation of a long is the two given signed, 32-bit values. We use 32-bit pieces because these are the size of integers on which Javascript performs bit-operations. For operations like addition and multiplication, we split each number into 16 bit pieces, which can easily be multiplied within Javascript's floating-point representation without overflow or change in sign. In the algorithms below, we frequently reduce the negative case to the positive case by negating the input(s) and then post-processing the result. Note that we must ALWAYS check specially whether those values are MIN_VALUE (-2^63) because -MIN_VALUE == MIN_VALUE (since 2^63 cannot be represented as a positive number, it overflows back into a negative). Not handling this case would often result in infinite recursion. Common constant values ZERO, ONE, NEG_ONE, etc. are found as static properties on this class.

Hierarchy

  • Long

Index

Constructors

  • new Long(low?: string | number | bigint, high?: number | boolean, unsigned?: boolean): Long
  • Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as signed integers. See the from* functions below for more convenient ways of constructing Longs.

    Acceptable signatures are:

    • Long(low, high, unsigned?)
    • Long(bigint, unsigned?)
    • Long(string, unsigned?)

    Parameters

    • Optional low: string | number | bigint

      The low (signed) 32 bits of the long

    • Optional high: number | boolean

      The high (signed) 32 bits of the long

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

Properties

__isLong__: true

An indicator used to reliably determine if an object is a Long or not.

_bsontype: "Long"
high: number

The high 32 bits as a signed value.

low: number

The low 32 bits as a signed value.

unsigned: boolean

Whether unsigned or not.

MAX_UNSIGNED_VALUE: Long

Maximum unsigned value.

MAX_VALUE: Long

Maximum signed value.

MIN_VALUE: Long

Minimum signed value.

NEG_ONE: Long

Signed negative one.

ONE: Long

Signed one.

TWO_PWR_24: Long
UONE: Long

Unsigned one.

UZERO: Long

Unsigned zero.

ZERO: Long

Signed zero

Methods

  • Returns the sum of this and the specified Long.

    Parameters

    Returns Long

  • Returns the sum of this and the specified Long.

    Parameters

    Returns Long

    Sum

  • This is an alias of Long.compare

    Parameters

    Returns 0 | 1 | -1

  • Compares this Long's value with the specified's.

    Parameters

    Returns 0 | 1 | -1

    0 if they are the same, 1 if the this is greater and -1 if the given one is greater

  • This is an alias of Long.divide

    Parameters

    Returns Long

  • Returns this Long divided by the specified. The result is signed if this Long is signed or unsigned if this Long is unsigned.

    Parameters

    Returns Long

    Quotient

  • This is an alias of Long.equals

    Parameters

    Returns boolean

  • Tests if this Long's value equals the specified's.

    Parameters

    Returns boolean

  • eqz(): boolean
  • This is an alias of Long.isZero

    Returns boolean

  • getHighBits(): number
  • Gets the high 32 bits as a signed integer.

    Returns number

  • getHighBitsUnsigned(): number
  • Gets the high 32 bits as an unsigned integer.

    Returns number

  • getLowBits(): number
  • Gets the low 32 bits as a signed integer.

    Returns number

  • getLowBitsUnsigned(): number
  • Gets the low 32 bits as an unsigned integer.

    Returns number

  • getNumBitsAbs(): number
  • Gets the number of bits needed to represent the absolute value of this Long.

    Returns number

  • Tests if this Long's value is greater than the specified's.

    Parameters

    Returns boolean

  • greaterThanOrEqual(other: string | number | Long | Timestamp): boolean
  • Tests if this Long's value is greater than or equal the specified's.

    Parameters

    Returns boolean

  • This is an alias of Long.greaterThan

    Parameters

    Returns boolean

  • inspect(): string
  • Returns string

  • isEven(): boolean
  • Tests if this Long's value is even.

    Returns boolean

  • isNegative(): boolean
  • Tests if this Long's value is negative.

    Returns boolean

  • isOdd(): boolean
  • Tests if this Long's value is odd.

    Returns boolean

  • isPositive(): boolean
  • Tests if this Long's value is positive.

    Returns boolean

  • isZero(): boolean
  • Tests if this Long's value equals zero.

    Returns boolean

  • Tests if this Long's value is less than the specified's.

    Parameters

    Returns boolean

  • lessThanOrEqual(other: string | number | Long | Timestamp): boolean
  • Tests if this Long's value is less than or equal the specified's.

    Parameters

    Returns boolean

  • This is an alias of {@link Long#lessThan}.

    Parameters

    Returns boolean

  • This is an alias of Long.modulo

    Parameters

    Returns Long

  • Returns this Long modulo the specified.

    Parameters

    Returns Long

  • Returns the product of this and the specified Long.

    Parameters

    Returns Long

    Product

  • This is an alias of Long.notEquals

    Parameters

    Returns boolean

  • This is an alias of Long.negate

    Returns Long

  • Returns the Negation of this Long's value.

    Returns Long

  • This is an alias of Long.notEquals

    Parameters

    Returns boolean

  • Returns the bitwise NOT of this Long.

    Returns Long

  • Tests if this Long's value differs from the specified's.

    Parameters

    Returns boolean

  • Returns the bitwise OR of this Long and the specified.

    Parameters

    • other: string | number | Long

    Returns Long

  • This is an alias of Long.modulo

    Parameters

    Returns Long

  • Returns this Long with bits shifted to the left by the given amount.

    Parameters

    • numBits: number | Long

      Number of bits

    Returns Long

    Shifted Long

  • shiftRight(numBits: number | Long): Long
  • Returns this Long with bits arithmetically shifted to the right by the given amount.

    Parameters

    • numBits: number | Long

      Number of bits

    Returns Long

    Shifted Long

  • shiftRightUnsigned(numBits: number | Long): Long
  • Returns this Long with bits logically shifted to the right by the given amount.

    Parameters

    • numBits: number | Long

      Number of bits

    Returns Long

    Shifted Long

  • This is an alias of Long.shiftLeft

    Parameters

    • numBits: number | Long

    Returns Long

  • This is an alias of Long.shiftRight

    Parameters

    • numBits: number | Long

    Returns Long

  • Returns the difference of this and the specified Long.

    Parameters

    Returns Long

    Difference

  • toBigInt(): bigint
  • Converts the Long to a BigInt (arbitrary precision).

    Returns bigint

  • toBytes(le?: boolean): number[]
  • Converts this Long to its byte representation.

    Parameters

    • Optional le: boolean

      Whether little or big endian, defaults to big endian

    Returns number[]

    Byte representation

  • toBytesBE(): number[]
  • Converts this Long to its big endian byte representation.

    Returns number[]

    Big endian byte representation

  • toBytesLE(): number[]
  • Converts this Long to its little endian byte representation.

    Returns number[]

    Little endian byte representation

  • toExtendedJSON(options?: Options): number | LongExtended
  • Parameters

    • Optional options: Options

    Returns number | LongExtended

  • toInt(): number
  • Converts the Long to a 32 bit integer, assuming it is a 32 bit integer.

    Returns number

  • toNumber(): number
  • Converts the Long to a the nearest floating-point representation of this value (double, 53 bit mantissa).

    Returns number

  • Converts this Long to signed.

    Returns Long

  • toString(radix?: number): string
  • Converts the Long to a string written in the specified radix.

    throws

    RangeError If radix is out of range

    Parameters

    • Optional radix: number

      Radix (2-36), defaults to 10

    Returns string

  • Converts this Long to unsigned.

    Returns Long

  • xor(other: string | number | Long): Long
  • Returns the bitwise XOR of this Long and the given one.

    Parameters

    • other: string | number | Long

    Returns Long

  • fromBigInt(value: bigint, unsigned?: boolean): Long
  • Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned.

    Parameters

    • value: bigint

      The number in question

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

    The corresponding Long value

  • fromBits(lowBits: number, highBits: number, unsigned?: boolean): Long
  • Returns a Long representing the 64 bit integer that comes by concatenating the given low and high bits. Each is assumed to use 32 bits.

    Parameters

    • lowBits: number

      The low 32 bits

    • highBits: number

      The high 32 bits

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

    The corresponding Long value

  • fromBytes(bytes: number[], unsigned?: boolean, le?: boolean): Long
  • Creates a Long from its byte representation.

    Parameters

    • bytes: number[]

      Byte representation

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    • Optional le: boolean

      Whether little or big endian, defaults to big endian

    Returns Long

    The corresponding Long value

  • fromBytesBE(bytes: number[], unsigned?: boolean): Long
  • Creates a Long from its big endian byte representation.

    Parameters

    • bytes: number[]

      Big endian byte representation

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

    The corresponding Long value

  • fromBytesLE(bytes: number[], unsigned?: boolean): Long
  • Creates a Long from its little endian byte representation.

    Parameters

    • bytes: number[]

      Little endian byte representation

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

    The corresponding Long value

  • fromExtendedJSON(doc: { $numberLong: string }, options?: Options): number | Long
  • Parameters

    • doc: { $numberLong: string }
      • $numberLong: string
    • Optional options: Options

    Returns number | Long

  • fromInt(value: number, unsigned?: boolean): Long
  • Returns a Long representing the given 32 bit integer value.

    Parameters

    • value: number

      The 32 bit integer in question

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

    The corresponding Long value

  • fromNumber(value: number, unsigned?: boolean): Long
  • Returns a Long representing the given value, provided that it is a finite number. Otherwise, zero is returned.

    Parameters

    • value: number

      The number in question

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

    The corresponding Long value

  • fromString(str: string, unsigned?: boolean, radix?: number): Long
  • Returns a Long representation of the given string, written using the specified radix.

    Parameters

    • str: string

      The textual representation of the Long

    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    • Optional radix: number

      The radix in which the text is written (2-36), defaults to 10

    Returns Long

    The corresponding Long value

  • fromValue(val: string | number | { high: number; low: number; unsigned?: boolean }, unsigned?: boolean): Long
  • Converts the specified value to a Long.

    Parameters

    • val: string | number | { high: number; low: number; unsigned?: boolean }
    • Optional unsigned: boolean

      Whether unsigned or not, defaults to signed

    Returns Long

  • isLong(value: unknown): value is Long
  • Tests if the specified object is a Long.

    Parameters

    • value: unknown

    Returns value is Long

Generated using TypeDoc