Class UUID

Represents a UUID that can be used as an _id in the DataAPI.

Provides methods for creating v4 and v7 UUIDs, and for parsing timestamps from v7 UUIDs.

Example

const collection = await db.createCollection('myCollection'. {
  defaultId: {
    type: 'uuidv7',
  },
});

await collection.insertOne({ album: 'Jomsviking' });

const doc = await collection.findOne({ album: 'Jomsviking' });

// Prints the UUID of the document
console.log(doc._id.toString());

// Prints the timestamp when the document was created (server time)
console.log(doc._id.getTimestamp());

Example

await collection.insertOne({ _id: UUID.v4(), album: 'Berserker' });

const doc = await collection.findOne({ album: 'Berserker' });

// Prints the UUID of the document
console.log(doc._id.toString());

// Undefined, as the document was created with a v4 UUID
console.log(doc._id.getTimestamp());

See

ObjectId

Constructors

constructor

Properties

_raw version

Methods

equals getTimestamp inspect toJSON toString v4 v7

Constructors

constructor

  • new UUID(uuid, validate?): UUID

  • Creates a new UUID instance.

    Use UUID.v4() or UUID.v7() to generate random new UUIDs.

    Parameters

    • uuid: string

      The UUID string.

    • validate: boolean = true

      Whether to validate the UUID string. Defaults to true.

    Returns UUID

Properties

Private Readonly _raw

_raw: string

Readonly version

version: number

The version of the UUID.

Methods

equals

  • equals(other): boolean

  • Compares this UUID to another UUID.

    The other UUID can be a UUID instance or a string.

    A UUID is considered equal to another UUID if their lowercase string representations are equal.

    Parameters

    • other: unknown

      The UUID to compare to.

    Returns boolean

    true if the UUIDs are equal, false otherwise.

getTimestamp

  • getTimestamp(): undefined | Date

  • Returns the timestamp of a v7 UUID. If the UUID is not a v7 UUID, this method returns undefined.

    Returns undefined | Date

    The timestamp of the UUID, or undefined if the UUID is not a v7 UUID.

inspect

toJSON

  • toJSON(): {
        $uuid: string;
    }

  • Converts the UUID to a JSON representation.

    Serializes to { $uuid: 'uuid' }.

    Returns {
        $uuid: string;
    }

    • $uuid: string

toString

  • toString(): string

  • Returns the string representation of the UUID in lowercase.

    Returns string

Static v4

Static v7

Settings

Member Visibility

Theme

On This Page

constructor_rawversionequalsgetTimestampinspecttoJSONtoStringv4v7