Set of utilities to work with UUID
npm i @aminzer/uuid
import uuid, { isValid } from '@aminzer/uuid';
const someUuid = uuid();
console.log(`${someUuid} is UUID: ${isValid(someUuid)}`);
const notUuid = 'abc';
console.log(`${notUuid} is UUID: ${isValid(notUuid)}`);
uuid
uuid
generates random UUID string.
import uuid from '@aminzer/uuid';
console.log(uuid());
options
(object
, optional):hyphens
(boolean
, optional,true
by default) - should generated string have UUID hyphen-separators or not.
Generated UUID string.
generate
Named alias of default export of the module. Following statements import the same function:
import uuid from '@aminzer/uuid';
import { generate } from '@aminzer/uuid';
generateBytes
generateBytes
generates Uint8Array
with UUID content.
import { generateBytes } from '@aminzer/uuid';
console.log(generateBytes());
Uint8Array
with generated UUID content.
isValid
isValid
checks if passed string has UUID format.
import { isValid } from '@aminzer/uuid';
console.log(isValid('a2b8c6bf-f5e9-4231-8319-7d577b7f8064'));
uuidString
(string
, required) - string that need to be checked.options
(object
, optional):hyphens
(boolean
, optional,true
by default) - should input string have UUID hyphen-separators or not.
boolean
determining if input string has UUID format or not.
parse
parse
converts input UUID string to UUID Uint8Array
.
import { parse } from '@aminzer/uuid';
console.log(parse('a2b8c6bf-f5e9-4231-8319-7d577b7f8064'));
uuidString
(string
, required) - string to be parsed.options
(object
, optional):validate
(boolean
, optional,true
by default) - validate input string format or not.
UUID Uint8Array
parsed from input UUID string.
stringify
stringify
converts input UUID Uint8Array
to UUID string.
import { stringify, generateBytes } from '@aminzer/uuid';
const uuidBytes = generateBytes();
console.log(stringify(uuidBytes));
uuidBytes
(Uint8Array
, required) - bytes to be stringified.options
(object
, optional):validate
(boolean
, optional,true
by default) - validate input bytes format or not.hyphens
(boolean
, optional,true
by default) - add hyphens into output string or not.uppercase
(boolean
, optional,false
by default) - convert output string to uppercase or not.
UUID string stringified from input UUID Uint8Array
.