api.service.Uuid

This service of Hitchy's core is providing methods for conveniently handling UUIDs. It is supporting UUIDs encoded as strings and UUIDs provided as a Buffer of 16 octets.

Static methods

create()

This method generates a random UUIDv4 using a cryptographically strong pseudo-random number generator. It returns a promise for the generated UUID provided as a 16-octets Buffer.

const uuid = await api.service.Uuid.create();

format()

This method takes a 16-octets Buffer assumed to contain a UUID as sole argument and returns a string representing that UUID in the common format.

console.log( api.service.Uuid.format( uuidBuffer ) ); // prints e.g. "12345678-1234-1234-1234-123456789abc"

isUUID()

The method tests whether some value provided as argument is a UUID or not. The test succeeds if either condition is satisfied:

• Provided value is a Buffer with at least 16 octets.
• Provided value is a string matching regular expression testing for compliance with common UUID format.

console.log( api.service.Uuid.isUUID( Buffer.alloc( 16 ) ) ); // true
console.log( api.service.Uuid.isUUID( "12345678-1234-1234-1234-123456789abc" ) ); // true

normalize()

The method is meant to convert different formats of a UUID given in first argument into a 16-octets buffer containing that UUID.

The binary form is preferred as normal form due to its least amount of memory consumed.

Supported values are

• nullish values, resulting in null being returned.
• instances of Buffer with at least 16 octets, resulting in a slice of that buffer containing first 16 octets being returned.
• strings matching common format for representing UUID values, resulting in a 16-octets buffer containing that UUID being returned.

In all other cases, an exception is thrown.