Generate predictable and unique identifiers composed of adjectives and animal names, with the ability to seed the random identifiers.
Range of IDs
Currently, there are 1347 adjectives and 221 animals. The more adjectives used, the more possible combinations of IDs available.
For a quick reference, with 2 adjectives used, there are 400,984,389 possible unique IDs.
With 3 adjectives, there are 540,125,971,983 possible unique IDs.
Installation
$ npm install zoo-ids
Usage
Examples
import { generateId } from 'zoo-ids';
generateId('short seed'); // KnobbyNauticalKingfisher
// Any object can be used as a seed.
generateId(
{ key: 'value' },
{
caseStyle: 'camelcase',
}
); // weeklyGreatRacoon
// Defaults to the current time if seed is null.
generateId(null, {
caseStyle: 'lowercase',
delimiter: '🍓',
}); // enchanted🍓narrow🍓wallaby
Documentation
generateId(seed, opts?)
seed: any
The seed used to generate the id. This allows us to generate predictable, but random and unique identifiers.
Defaults to the current time in milliseconds.
opts.numAdjectives: number
The number of adjectives to use in the identifier.
Defaults to 2
.
opts.delimiter: string
The delimiter used between words. The delimiter will also be used between multi-word adjectives.
Defaults to ''
.
opts.caseStyle: string
The case style for the words. Possible options are 'titlecase'
, 'camelcase'
, 'uppercase'
, 'lowercase'
, and 'togglecase'
.
generateId('titlecase', { caseStyle: 'titlecase' }); // FineAntiqueElk
generateId('camelcase', { caseStyle: 'camelcase' }); // pertinentPoshGoldfinch
generateId('uppercase', { caseStyle: 'uppercase' }); // PIERCINGRESPONSIBLECAMEL
generateId('lowercase', { caseStyle: 'lowercase' }); // imaginarywingedsalamander
generateId('togglecase', { caseStyle: 'togglecase' }); // sTuNnInGdEsCrIpTiVepEaFoWl
Defaults to 'titlecase'
.
Credits
This project was inspired by the url ids used by gfycat.com.
The seeded random number generator used is powered by the alea algorithm by
Johannes Baagøe <baagoe@baagoe.com>
, ported by nquinlan/better-random-numbers-for-javascript-mirror.