Class UUID

constructor

• new UUID(input?): mongoose.mongo.BSON.UUID

• Create a UUID type

  When the argument to the constructor is omitted a random v4 UUID will be generated.

  Parameters

  • Optional input: string | Uint8Array | mongoose.mongo.BSON.UUID

    Can be a 32 or 36 character hex string (dashes excluded/included) or a 16 byte binary Buffer.

    Optional

  Returns mongoose.mongo.BSON.UUID

Static cacheHexString

id

• get id(): Uint8Array

• The UUID bytes

  Returns Uint8Array

equals

• equals(otherId): boolean

• Compares the equality of this UUID with otherID.

  Parameters

  • otherId: string | Uint8Array | mongoose.mongo.BSON.UUID

    UUID instance to compare against.

  Returns boolean

inspect

• inspect(): string

• Returns string

toBinary

• toBinary(): Binary

• Creates a Binary instance from the current UUID.

  Returns Binary

toHexString

• toHexString(includeDashes?): string

• Returns the UUID id as a 32 or 36 character hex string representation, excluding/including dashes (defaults to 36 character dash separated)

  Parameters

  • Optional includeDashes: boolean

    should the string exclude dash-separators.

    Optional

  Returns string

toJSON

• toJSON(): string

• Converts the id into its JSON string representation. A 36 character (dashes included) hex string in the format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

  Returns string

toString

• toString(encoding?): string

• Converts the id into a 36 character (dashes included) hex string, unless a encoding is specified.

  Parameters

  • Optional encoding: "base64" | "hex"

    Optional

  Returns string

Static createFromBase64

• createFromBase64(base64): mongoose.mongo.BSON.UUID

• Creates an UUID from a base64 string representation of an UUID.

  Parameters

  • base64: string

  Returns mongoose.mongo.BSON.UUID

Static createFromHexString

• createFromHexString(hexString): mongoose.mongo.BSON.UUID

• Creates an UUID from a hex string representation of an UUID.

  Parameters

  • hexString: string

    32 or 36 character hex string (dashes excluded/included).

  Returns mongoose.mongo.BSON.UUID

Static generate

• generate(): Uint8Array

• Generates a populated buffer containing a v4 uuid

  Returns Uint8Array

Static isValid

• isValid(input): boolean

• Checks if a value is a valid bson UUID

  Parameters

  • input: string | Uint8Array | Binary | mongoose.mongo.BSON.UUID

    UUID, string or Buffer to validate.

  Returns boolean