human-id
v4.1.1
Published
Returns from a pool of 10m human-readable IDs
Downloads
4,780,878
Maintainers
Readme
Human-Readable Identifiers
Using words to identify datasets (instead of numbers) provides various advantages when humans are involved, ie increased distinction and rememberability.
Human-ID generates readable strings by chaining common short words of the english language in a semi-meaningful way.
The result is concatenated of adjective + noun + verb
resulting in a minimum pool size of 15 000 000 possible combinations.
- SFW: no bad words; family friendly results
- No dependencies
Examples
- FortyGhostsTalk
- CalmSnailsDream
- TastyRocksSparkle
- HealthyCowsSmile
- AfraidWallsExist
- StrangeCarsRush
- TwoLizardsSing
- HappyLionsJump
Install
Yarn
yarn add human-id
NPM
npm install human-id
Usage
Command line
npx human-id
# RareGeckosJam
npx human-id lowercase + 2x
# rare+geckos+jam
# healthy+cows+smile
Programmatic
import {humanId, poolSize, minLength, maxLength} from 'human-id'
// RareGeckosJam
humanId()
// Rare~Geckos~Jam
// alias for { separator: '~' }
humanId('~')
// rare-geckos-jam
humanId({
separator: '-',
capitalize: false,
})
poolSize() // 15,000,000
minLength() // 8
maxLength() // 19
Extended Pool Size
For most cases, the default pool size should be large enough. However, the options adjectiveCount
and addAdverb
can be utilized to increase the pool size for the price of the string length.
const options = {
adjectiveCount: 2,
addAdverb: true,
separator: '.'
}
humanId(options) // Ten.Wet.Files.Cheer.Lazily
poolSize(options) // 630,000,000
minLength(options) // 20
maxLength(options) // 41
Executable arguments
Use the following arguments to modify the default options or print multiple results.
| Argument | Effect |
| -------------------------- | ------------------------------------------------- |
| a
, adverb
, addAdverb
| Sets option.addAdverb
to true
|
| l
, lower
, lowercase
| Sets option.capitalize
to false
|
| space
| Sets option.separator
to an empty space
|
| any number | Sets option.adjectiveCount
to the given integer |
| any single character | Sets option.separator
to the character |
| any number followed by x
| Repeats the output number
times |
Example
npx human-id adverb lower 2 _ 3x
# clever_shaggy_memes_sit_quietly
# cuddly_spicy_boxes_wave_politely
# sweet_fair_wombats_fetch_bravely
API
humanId(options?: string | Option): string
Generates a human ID. Options can be a string
(separator), a boolean
(capitalize) or an Options
object of:
- separator
string = ''
- Separates the words from each other - capitalize
boolean = true
- Whether to transform the first character of each word to upper case - adjectiveCount
number = 1
- How many adjectives to return - addAdverb
boolean = false
- Adds a fourth part to the id
This function is also available as the default export
poolSize(options?: string | Option): number
Returns the number of possible combinations for a given set of options.
minLength(options?: Option): number
The length of the shortest possible id for a given set of options.
maxLength(options?: Option): number
The length of the longest possible id for a given set of options.
adjectives: string[]
List of possible values for the first part of the human id.
nouns: string[]
List of possible values for the second part of the human id.
verbs: string[]
List of possible values for the third part of the human id.
adverbs: string[]
List of possible values for the optional fourth part of the human id.