human-uuid

Generate human-readable IDs with a prefix using UUID v7 and base58 encoding.

Installation

npm install human-uuid
# or
yarn add human-uuid
# or
pnpm add human-uuid

Usage

import { humanUUID } from 'human-uuid';

// Generate IDs with different prefixes
const userId = humanUUID('user'); // user_1BVXue8CnY6eSRFn2bDLFU
const orderId = humanUUID('order'); // order_1BVXue8D4K7gTRHp3eDMGV
const apiKeyId = humanUUID('api-key'); // api-key_1BVXue8DfN8hUSIq4fENHW

// IDs are time-ordered (later IDs > earlier IDs)
const firstId = humanUUID('task');
const secondId = humanUUID('task');
console.log(secondId > firstId); // true

API

Generates a unique ID in the format {prefix}_{base58UUID}.

• prefix: Required string prefix for the ID
• Returns: TypeScript-typed ID string with the prefix

Features

• Time-ordered: Uses UUID v7 for chronological sorting
• Compact: Base58 encoding for shorter, URL-safe IDs
• Type-safe: Full TypeScript support with prefix typing
• Fast: 1000+ IDs per second generation

Dependencies

• uuid - UUID v7 generation
• @scure/base - Base58 encoding

License

MIT - Tran Cong [email protected]