Class Location

constructor

• new Location(group: number | bigint, object: number | bigint): Location

  Constructs a new Location.

  Parameters

  • group: number | bigint

    The group index (number or bigint).

  • object: number | bigint

    The object index (number or bigint).

  Returns Location

Readonlygroup

Readonlyobject

compare

• compare(other: Location): number

  Compares this Location to another for ordering.

  Parameters

  • other: Location

    The other Location to compare.

  Returns number

  -1 if this < other, 1 if this > other, 0 if equal.

equals

• equals(other: Location): boolean

  Checks if this Location is equal to another.

  Parameters

  • other: Location

    The other Location to compare.

  Returns boolean

  True if both group and object are equal.

serialize

• serialize(): FrozenByteBuffer

  Serializes this Location to a FrozenByteBuffer.

  Returns FrozenByteBuffer

  The serialized buffer.

  Throws

  CastingError if group or object is negative.

  Throws

  VarIntOverflowError if group or object exceeds varint encoding limits.

Staticdeserialize

• deserialize(buf: BaseByteBuffer): Location

  Deserializes a Location from a buffer.

  Parameters

  • buf: BaseByteBuffer

    The buffer to read from.

  Returns Location

  The deserialized Location.

  Throws

  NotEnoughBytesError if buffer does not contain enough bytes.