Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

simple-human-ids

2.0.4 • Public • Published

simple-human-ids-js

Use JavaScript to generate human-readable ids from a lists of adjectives, nouns, and verbs.

Generate ids in the format of #-adjective-noun-verb-adverb such as

  • 24-silly-goose-ran-quickly
  • 15-quick-cobra-sold-randomly
  • 23-tricky-chicken-bought-downstairs
  • 90-brave-ladybug-looked-jumped-everywhere

I frequently want human readable ids I can type without checking it multiple times. I should be able to yell these ids across the room and have people be able to enter it without confusion.

Currently the id space is about 200,000,000 ids (100 * 100 * 75 * 18 * 15).

The goal is to increase the word space to at least 1 billion while preserving the philosophy that the id would be human readable and simple to spell.

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.

Usage

NPM

# from npm 
npm install --save simple-human-ids
const id = require('simple-human-id');
 
// generate 100 random ids
for ( let i = 0; i < 100; i++ ) {
  console.log( id.new() );
}

You are also able to configure your own lists to use

const id = require( 'simple-human-ids' );
 
const numbers = [ 3, 5, 9, ... ];
const adjectives = [ 'soft', 'hard', 'wet', ... ];
const nouns = [ 'goose', 'chicken', 'ship', ... ];
 
const lists = id.construct( numbers, adjectives, nouns );
id.configure( lists );
 
for( let i = 0; i < 100; i++ ){
    console.log( id.new() );
}

Acknowledgement

This project was as effort to expand on CoolAJ87's Human Readable IDs project.

Install

npm i simple-human-ids

DownloadsWeekly Downloads

1

Version

2.0.4

License

MIT

Unpacked Size

10.9 kB

Total Files

13

Last publish

Collaborators

  • avatar