README.md

uuidv4

uuidv4 creates v4 UUIDs.

Status

Category	Status
Version
Dependencies
Dev dependencies
Build
License

Installation

$ npm install uuidv4

Quick start

First you need to integrate uuidv4 into your project by using the require function:

const { uuid } = require('uuidv4');

If you use TypeScript, use the following code instead:

import { uuid } from 'uuidv4';

Then you can create UUIDs. To do so simply call the uuid function:

console.log(uuid());
// => '11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000'

Verifying a UUID

To verify whether a given value is a UUID, use the isUuid function:

import { isUuid } from 'uuidv4';

console.log(isUuid('75442486-0878-440c-9db1-a7006c25a39f'));
// => true

Please note that the isUuid function returns true for both, v4 and v5 UUIDs. In addition, isUuid returns true for empty().

Using a regular expression

If you want to perform the verification on your own using a regular expression, use the regex property, and access its v4 or v5 property, depending on what you need:

import { regex } from 'uuidv4';

console.log(regex.v4);
console.log(regex.v5);

Please note that the regular expressions also consider empty() to be a valid UUID.

Using a JSON schema

If you want to perform the verification on your own using a JSON schema, use the jsonSchema property, and access its v4 or v5 property, depending on what you need:

import { jsonSchema } from 'uuidv4';

console.log(jsonSchema.v4);
console.log(jsonSchema.v5);

Please note that the JSON schemas also consider empty() to be a valid UUID.

Getting a UUID from a string

From time to time you need an identifier that looks like a UUID, but is actually inferred from a string. For that, use the fromString function, which returns a UUID v5:

import { fromString } from 'uuidv4';

console.log(fromString('the native web'));
// => 'cdb63720-9628-5ef6-bbca-2e5ce6094f3c'

Getting the empty UUID

If you need a UUID that consists only of zeros, use the empty function:

import { empty } from 'uuidv4';

console.log(empty());
// => '00000000-0000-0000-0000-000000000000'

Running the build

To build this module use roboter.

$ npx roboter