generateId

Import

import { generateId } from "@arkyn/shared";

Parameters

• Type: "text" | "binary"
• Description: The desired output type for the UUID.
• "text": Returns the UUID as a string.
• "binary": Returns the UUID as a Uint8Array in binary format. - Required: Yes
• Default: N/A

• Type: "v4" | "v7"
• Description: The version of the UUID to generate.
• "v4": Generates a random UUID (version 4).
• "v7": Generates a time-ordered UUID (version 7).
• Required: Yes
• Default: N/A

Returns

• If type is text, returns a string.
• If type is binary, returns a Uint8Array.

Errors

• Error("Invalid type or format"): If an invalid type or format is provided.

Usage Example

Generate a v4 UUID as Text

import { generateId } from "./generateId";

const idTextV4 = generateId("text", "v4");
console.log(idTextV4); // Ex: "550e8400-e29b-41d4-a716-446655440000"

Generate a v7 UUID as Binary

import { generateId } from "./generateId";

const idBinaryV7 = generateId("binary", "v7");
console.log(idBinaryV7); // Output: Uint8Array([...])