uuid-v4-validator

UUID v4

Generate, manage and validate easily Universally Unique Identifiers v4

Description

This package provides the essential methods to generate and validate Universally Unique Identifiers v4, that you can use for naming or identify elements in a list, documents in a databases, variables or whatever you want.

Is a collision between 2 randomly generated UUIDs possible? According to the Birthday Paradox, the probability of finding a collision between 2 UUID within 103 trillion UUIDs is one in a billion. The number of random UUIDs which need to be generated in order to have a 50% probability of at least one collision is 2.71 quintillion.

Supported languages

• Typescript
• Javascript ES5

Installation

npm install uuid-v4-validator

Reference index

Classes

UUIDv4

Properties

UUIDv4.id
UUIDv4.stopExecutionAtError

Methods

UUIDv4.generate
UUIDv4.validate
UUIDv4.renewId

Reference

UUIDv4

• Class
• Constructor: ( id?: string )

Create a UUIDv4 instance with an own generated random id. You can pass a custom uuid that will be validate. ⚠ Generate an error if the provided id doesn't pass the validation.

---

UUIDv4.id

• string

get: The current id. It's always valid set: Set a new custom id. ⚠ Generate an error if the provided id doesn't pass the validation.

---

UUIDv4.stopExecutionAtError

• boolean

⚠ NOT SAFE - Generate a warn instead of stopping execution at runtime, this allow the storage of invalid ids

---

UUIDv4.generate

• Function (): string
• Return: A valid UUID v4 string

Generate a new UUID v4 string.

---

UUIDv4.validate

• Function ( arg: string | Object | UUIDv4 ): boolean

Return true if the provided UUID v4 string passes the validation or the provided Object or UUIDv4 instance has a valid UUID v4 and format

---

UUIDv4.renewId

• Function (): void

Generate a new instance id that will override the old one

---

Examples

• Create an UUIDv4 instance with a random generated UUID v4

import UUIDv4 from "uuid-v4-validator";

const userId = new UUIDv4();

console.log(userId);
// Return a UUIDv4 instance
// Expected output: UUIDv4 { _id: "s4F68hFDf-d3R5-4Rt6-dRgi-dEji85feY51s" }

console.log(userId.id);
// Return UUID as string
// Expected output: "s4F68hFDf-d3R5-4Rt6-dRgi-dEji85feY51s"

• Create a UUIDv4 instance with a custom string

import UUIDv4 from "uuid-v4-validator";

const userId1 = new UUIDv4("s4F68hFDf-d3R5-4Rt6-dRgi-dEji85feY51s");

console.log(userId);
// Return a UUIDv4 instance
// Expected output: UUIDv4 { _id: "s4F68hFDf-d3R5-4Rt6-dRgi-dEji85feY51s" }

const userId2 = new UUIDv4("s4F68hF");
// Execution stops due to an error
// Expected output: The provided UUIDv4 "s4F68hF" string doesn't pass the validation. Use a valid UUIDv4 string or generate a new one

• Validate an UUIDv4 instance, an UUIDv4-like object or an UUID v4 string

import UUIDv4 from "uuid-v4-validator";

const importedId = "s4F68hFDf-d3R5-4Rt6-dRgi-dEji85feY51s";
console.log(UUIDv4.validate(importedId));
// Return true if the provided ID respect the UUID v4 standards
// Expected output: true

const importedIdInstance = new UUIDv4();
console.log(UUIDv4.validate(importedIdInstance));
// Return true if the provided object is a valid UUIDv4 instance and the ID respects the UUID v4 standards
// Expected output: true

const importedIdObject = {
  _id: "s4F68hFDf-d3R5-4Rt6-dRgi-dEji85feY51s"
};
console.log(UUIDv4.validate(importedIdObject));
// Return true if the provided object can be casted to a valid UUIDv4 instance and the ID respect the UUID v4 standards
// Expected output: true

• Set a new custom id

import UUIDv4 from "uuid-v4-validator";

const uuidv4Instance = new UUIDv4();

const validId = "s4F68hFDf-d3R5-4Rt6-dRgi-dEji85feY51s";
const invalidId = "s4F68";

uuidv4Instance.id = validId;

console.log(uuidv4Instance.id);
// Return true if the provided ID respect the UUID v4 standards
// Expected output: true

uuidv4Instance.id = invalidId;
// Execution stops due to an error
// Expected output: The provided UUIDv4 "s4F68h" string doesn't pass the validation. Use a valid UUIDv4 string or generate a new one

Links

• RFC 4122
• DCE 1.1: Authentication and Security Services

License

UUID v4 package released under MIT License. See LICENSE for details.