Generate compact and globally unique ids with or without prefixing.
npm install @xgsd/uniqidAt xGSD we generate a lot of IDs, from logging to identification, we need IDs that are consistent, human-readable, and globally unique without fear of collision. We have two primary IDs in use: uniqid and tinyid. Tiny IDs are used in shareable links and are typically less than 8 characters long (with prefix).
Do not use tinyid without collision detection or prevention mechanisms. The short-lived nature of the URLs we generate means collision for us is very unlikely. Check your own application and use case before continuing with tinyid.
This package is publicly available in compliance with Make Data Mine Again 2025 (our internal policy at Myked and xGSD). We cannot offer support or maintainence outside of our project. Security concerns? Report these to us through our Github. Any security or collision issues/concerns will be addressed within 7 working days (typically sooner).
Install this library with yarn:
``sh`
yarn add @xgsd/uniqid
Commands:
- test: runs test runnertest:cov
- : runs test runner and generates coverage reports
Using this library is super simple, simply import the relevant function (uniqid/tinyid) and call it with or without arguments:
`ts
// example usage for uniqid()
import { uniqid } from "@xgsd/uniqid";
// ... somewhere in your application
const id = uniqid(); // will generate ID without prefix
const id2 = uniqid("pre"); // generates ID with prefix of "pre"
const id3 = uniqid("pre", "myUserId"); // generate ID with prefix and base
const id4 = uniqid("pre", "myUserId", 8); // generate ID with prefix, base, and custom length.
// example for tinyid()
import { tinyid } from "@xgsd/uniqid";
// ... somewhere in your application
const id = tinyid(); // generate 6 character-long ID without prefix
const id2 = tinyid("pre"); // generates ID with prefix
const id3 = tinyid("pre", generatorFn); // generate tiny ID with custom generator function.
// custom generators
const generatorFn = (prefix?: string, from?: string, length?: number) =>
"some generated id";
``