tempoid
v0.2.0
Published
A library to generate URL-friendly, unique, and short IDs that are sortable by time. Inspired by nanoid and UUIDv7.
Downloads
20
Maintainers
Readme
Tempo ID
Short IDs with temporal ordering.
A library to generate URL-friendly, unique, and short IDs that are sortable by time. Inspired by nanoid and UUIDv7.
See tempoid.dev for more information.
Motivation
- URL-friendly: The IDs are easy to select and copy.
- Unique: The IDs are practically unique and can be used in distributed systems.
- Short: The IDs are shorter than UUIDs because they are encoded with a larger alphabet.
- Sortable: The IDs are sortable by time because a timestamp is encoded in the beginning of the ID.
- Customizable: You can configure the ID length and the characters used.
Example ID:
0uoVxkjTFsrRX30O5B9fX
<------><----------->
Time Random
Collisions
- Same millisecond: There can be only a collision if two IDs are generated in the same millisecond.
- Low probability: Even if two IDs are generated in the same millisecond, the probability of a collision is very low.
The 13 random characters exceed the randomness of UUIDv7 (≈10^23 vs ≈10^22).
Getting Started
Add the package to your project:
npm install tempoid
Usage
import { tempoId, Alphabet } from 'tempoid';
const id = tempoId();
console.log('Generated TempoId:', id);
Parameters
➤ Length
By default, the length of the ID is 21 characters.
It contains an 8-character UNIX timestamp and an 13-character random string.
You can change the length by passing the timeLength
and randomLength
parameters.
const id = tempoId({ timeLength: 10, randomLength: 10 });
console.log('Generated TempoId:', id);
➤ Alphabet
By default, the ID is encoded with an alphanumeric alphabet ([A-Za-z0-9]
) without any special characters,
making it easy to select and copy.
You can change the alphabet by passing the alphabet
parameter.
// use a different alphabet
const id1 = tempoId({ alphabet: Alphabet.base64 });
// or create a custom alphabet
const id2 = tempoId({ alphabet: '0123456789abcdef' });