@alexjamesmalcolm/human-readable-ids
TypeScript icon, indicating that this package has built-in type declarations

1.0.12 • Public • Published

human-readable-ids

Use JavaScript to generate human-readable ids from a list of animals and adjectives.

ids are in the format of adjective-animal-## such as:

  • silly-goose-37
  • quick-cobra-15
  • tricky-chicken-23
  • brave-ladybug-90

My problem is that I often want ids that I can type without having to look at twice (nor telling someone else twice). I should be able to shout one of these ids across the room to a coworker or spouse and have them be able to enter it without any confusion.

Currently the id space is 12,520,970 ids (539 adjectives * 230 animals * 101 numbers).

The goal is to have several billion possible combinations by adding more words as well as expanding the ids to have verbs and adverbs. For a larger address space now, consider:

All of these also have the benefit of bi-directional conversion, but not all of them have words which are easy to pronounce and spell.

Contributing

Please add more words that fit these criteria

  • Easy-to-spell - such that even my redneck dad can manage
  • Phonetically distinct - no words like bore/boar
  • Few syllables
  • Well-known

All of the words are sorted alphabetically (sort -u) and stored in the *.txt files. The pre-publish script outputs the formatted javascript.

Bad Examples

  • wednesday, hamster, ostrich (difficult to spell)
  • grey, gray, bore, boar (two ways of spelling the same word or sound)
  • prawn (not well-known)

Resources

Add more words and strategies from

TODO

Achieve 1 trillion ids with a combination such as

number adjective noun verb adverb

42-red-foxes-run-quickly

And allow choosing various formats based on the desired number of ids.

  • adjective noun number
  • number adjective noun verb

Package Sidebar

Install

npm i @alexjamesmalcolm/human-readable-ids

Weekly Downloads

3

Version

1.0.12

License

Apache-2.0

Unpacked Size

38.5 kB

Total Files

20

Last publish

Collaborators

  • alexjamesmalcolm