Usage

🛠️ How to Use UCID

UCID (Unique Custom ID) is a lightweight utility for generating collision-resistant, human-readable IDs. Perfect for tagging resources, generating filenames, or creating unique keys in distributed systems.

📦 Installation

Install via npm:

npm install unique-custom-id

Or with yarn:

yarn add unique-custom-id

➕ Importing

Use it with your preferred module system:

ES Modules:

import ucid from 'unique-custom-id';

CommonJS:

const ucid = require('unique-custom-id');

🚀 Generate a Simple ID

Here's the most basic usage:

import ucid from 'unique-custom-id';

const id = ucid();

console.log(id);
// Example output: 04s1icu3-i8azmiyh-7rn045ip-sgrdupfq

Each ID is:

• 🔒 Collision-resistant
• 🧠 Human-readable
• 🌀 Composed of multiple entropy-rich segments

Next up → Configuration Options