ClassScru128Id

Represents a SCRU128 ID and provides converters and comparison operators.

Example

import { Scru128Id } from "scru128";

const x = Scru128Id.fromString("036z968fu2tugy7svkfznewkk");
console.log(String(x));

const y = Scru128Id.fromBigInt(0x017fa1de51a80fd992f9e8cc2d5eb88en);
console.log(y.toBigInt());

Conversion

toBigInt toHex toString fromBigInt fromBytes fromFields fromHex fromString

Other

bytes counterHi counterLo entropy timestamp clone compareTo equals toJSON ofInner

Conversion

toBigInt

  • toBigInt(): bigint

  • Returns the 128-bit unsigned integer representation.

    Returns bigint

toHex

  • toHex(): string

  • Returns the 128-bit unsigned integer representation as a 32-digit hexadecimal string prefixed with "0x".

    Returns string

toString

  • toString(): string

  • Returns the 25-digit canonical string representation.

    Returns string

StaticfromBigInt

  • fromBigInt(value): Scru128Id

  • Creates an object from a 128-bit unsigned integer.

    Parameters

    • value: bigint

    Returns Scru128Id

    Throws

    RangeError if the argument is out of the range of 128-bit unsigned integer.

StaticfromBytes

  • fromBytes(value): Scru128Id

  • Creates an object from a byte array representing either a 128-bit unsigned integer or a 25-digit Base36 string.

    This method shallow-copies the content of the argument, so the created object holds another instance of the byte array.

    Parameters

    • value: ArrayLike<number>

      An array of 16 bytes that contains a 128-bit unsigned integer in the big-endian (network) byte order or an array of 25 ASCII code points that reads a 25-digit Base36 string.

    Returns Scru128Id

    Throws

    SyntaxError if conversion fails.

StaticfromFields

  • fromFields(timestamp, counterHi, counterLo, entropy): Scru128Id

  • Creates an object from field values.

    Parameters

    • timestamp: number

      A 48-bit timestamp field value.

    • counterHi: number

      A 24-bit counter_hi field value.

    • counterLo: number

      A 24-bit counter_lo field value.

    • entropy: number

      A 32-bit entropy field value.

    Returns Scru128Id

    Throws

    RangeError if any argument is out of the value range of the field.

StaticfromHex

  • fromHex(value): Scru128Id

  • Creates an object from a 128-bit unsigned integer encoded in a hexadecimal string.

    Parameters

    • value: string

    Returns Scru128Id

    Throws

    SyntaxError if the argument is not a hexadecimal string encoding a 128-bit unsigned integer.

StaticfromString

  • fromString(value): Scru128Id

  • Creates an object from a 25-digit string representation.

    Parameters

    • value: string

    Returns Scru128Id

    Throws

    SyntaxError if the argument is not a valid string representation.

Other

Readonlybytes

bytes: Readonly<Uint8Array>

A 16-byte byte array containing the 128-bit unsigned integer representation in the big-endian (network) byte order.

counterHi

  • get counterHi(): number

  • Returns the 24-bit counter_hi field value.

    Returns number

counterLo

  • get counterLo(): number

  • Returns the 24-bit counter_lo field value.

    Returns number

entropy

  • get entropy(): number

  • Returns the 32-bit entropy field value.

    Returns number

timestamp

  • get timestamp(): number

  • Returns the 48-bit timestamp field value.

    Returns number

clone

  • clone(): Scru128Id

  • Creates an object from this.

    Note that this class is designed to be immutable, and thus clone() is not necessary unless properties marked as private are modified directly.

    Returns Scru128Id

compareTo

  • compareTo(other): number

  • Returns a negative integer, zero, or positive integer if this is less than, equal to, or greater than other, respectively.

    Parameters

    Returns number

equals

  • equals(other): boolean

  • Returns true if this is equivalent to other.

    Parameters

    Returns boolean

toJSON

  • toJSON(): string

  • Represents this in JSON as a 25-digit canonical string.

    Returns string

StaticofInner

  • ofInner(bytes): Scru128Id

  • Creates an object from the internal representation, a 16-byte byte array containing the 128-bit unsigned integer representation in the big-endian (network) byte order.

    This method does NOT shallow-copy the argument, and thus the created object holds the reference to the underlying buffer.

    Parameters

    • bytes: Uint8Array

    Returns Scru128Id

    Throws

    TypeError if the length of the argument is not 16.

Settings

Member Visibility

On This Page

Conversion
Other