uuid

The uuid utility generates a cryptographically strong Universally Unique Identifier (UUID) version 4, as specified in RFC 4122.

Source Code

View Source Code

/**
 * Generates a unique identifier.
 *
 * @example
 * ```ts
 * uuid(); // a unique identifier, e.g., '22a746d0-08be-4aff-bbc2-4deddf0914e0'
 * ```
 *
 * @returns A unique identifier.
 */
export function uuid(): string {
  return crypto.randomUUID();
}

Features

• Isomorphic: Works in both Browser and Node.js.
• Secure: Uses crypto.getRandomValues() in the browser and crypto.randomUUID() or crypto.randomBytes() in Node.js for high-quality randomness.
• Collision-Resistant: Provides 122 bits of randomness, making collisions practically impossible for most applications.

API

function uuid(): string;

Returns

• A string representing a randomly generated UUID v4 (e.g., 'f47ac10b-58cc-4372-a567-0e02b2c3d479').

Examples

Generating a Unique ID

import { uuid } from '@vielzeug/toolkit';

const userId = uuid();
const orderId = uuid();

console.log('User ID:', userId);
console.log('Order ID:', orderId);

Usage in Objects

import { uuid } from '@vielzeug/toolkit';

const items = [
  { id: uuid(), name: 'Item 1' },
  { id: uuid(), name: 'Item 2' },
];

Implementation Notes

• The function ensures that the version bit is set to 4 and the variant bit is set to 10xx (as per the RFC 4122 spec).
• In environments where a cryptographically secure RNG is not available (though rare in modern environments), it may fall back to Math.random(), but this is not recommended for security-sensitive applications.

See Also

• random: Generate random numbers in a range.
• draw: Pick a random element from an array.
• shuffle: Randomly reorder an array.