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 collections = await db.createCollection('myCollection'. {
  defaultId: {
    type: 'uuidv7',
  },
});

await collections.insertOne({ type: 'Jomsvikings' });

const doc = await collections.findOne({ type: 'Jomsvikings' });

// 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 collections.insertOne({ _id: UUID.v4(), car: 'toon' });

const doc = await collections.findOne({ car: 'toon' });

// 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

Implements

Constructors

constructor

Properties

_raw version

Methods

[$SerializeForCollection] [$SerializeForTable] equals getTimestamp toString [$DeserializeForCollection] [$DeserializeForTable] v1 v4 v6 v7

Constructors

constructor

  • new UUID(uuid, validate?, version?): UUID

  • Creates a new UUID instance.

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

    Parameters

    • uuid: string | UUID

      The UUID string.

    • validate: boolean = true

      Whether to validate the UUID string. Defaults to true.

    • version: number = 0

      The version of the UUID. If not provided, it is inferred from the UUID string.

    Returns UUID

Properties

Private Readonly _raw

_raw: string

Readonly version

version: number

The version of the UUID.

Methods

[$SerializeForCollection]

  • [$SerializeForCollection](ctx): readonly [0, undefined | {
        $uuid: string;
    }]

  • Implementation of $SerializeForCollection for TableCodec

    Parameters

    Returns readonly [0, undefined | {
        $uuid: string;
    }]

[$SerializeForTable]

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 v1 or v7 UUID. If the UUID is not a v1 or v7 UUID, this method returns undefined.

    Returns undefined | Date

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

toString

  • toString(): string

  • Returns the string representation of the UUID in lowercase.

    Returns string

Static [$DeserializeForCollection]

Static [$DeserializeForTable]

Static v1

Static v4

Static v6

Static v7

Settings

Member Visibility

Theme

On This Page

constructor_rawversion[$SerializeForCollection][$SerializeForTable]equalsgetTimestamptoString[$DeserializeForCollection][$DeserializeForTable]v1v4v6v7