@philiprehberger/cuid-ts

Collision-resistant sortable unique IDs for TypeScript

Installation

npm install @philiprehberger/cuid-ts

Usage

import { createId, createIdFactory, isCuid } from '@philiprehberger/cuid-ts';

// Generate a unique ID
const id = createId();
// => "clx8f0a3b00001k9z..."

// Generate with options
const customId = createId({ prefix: 'user', length: 32 });

// Create a pre-configured factory
const generateOrderId = createIdFactory({ prefix: 'ord', length: 28 });
const orderId = generateOrderId();

// Type guard
if (isCuid(someValue)) {
  // someValue is typed as Cuid
}

API

| Export | Description | | --- | --- | | createId(options?) | Generate a collision-resistant sortable unique ID. Options: prefix (default 'c'), length (default 24), fingerprint. | | createIdFactory(options) | Return a zero-argument function that generates IDs with the given options baked in. | | isCuid(value) | Type guard that returns true if value matches the CUID format (starts with a lowercase letter, lowercase alphanumeric). | | Cuid | Branded string type representing a valid CUID. | | CreateIdOptions | Options interface: prefix?: string, length?: number, fingerprint?: string. |

Development

npm install
npm run build
npm test
npm run typecheck

Support

If you find this project useful:

⭐ Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT