sharadbhat / readableurl

An NPM package to generate random readable phrases.

readable-url

An NPM package to generate readable random phrases to add to dynamically generated URLs.

GitHub repository

To generate readable URLs like Twitch's clips.

Example: https://clips.twitch.tv/WiseAcceptableSnoodPupper

Get started

To install,

npm install readable-url

Usage Instructions

To use the package, first require it.

const readable = require("readable-url");

Then, we create an object.

// Takes 3 parameters.
// 1. A boolean value - If true, returns string in CamelCase, else lowercase.
// 2. An integer value - The number of words to be generated in the string. (Between 2 and 10).
// 3. A string - The seperator between the words.

var generator = new readable(); // true, 3 and '' are the default values.

// var generator = new readable(false, 5, '-'); // Other options.

To generate a random phrase,

var url = generator.generate();

console.log(url); // Prints out 'ForgetfulHarshEgg'

This can be used to add to the end of a URL.

Example: https://example.com/photos/ForgetfulHarshEgg

For best results, use an integer value of 3, 4, or 5.

readableurl's Issues

Should not depend on `npm`

Noticed that in package.json this library depends on npm but it's not actually using it for anything in runtime.

Can this guarantee "uniqueness"?

Using uuid will give me amazing "uniquess" on the generated ID, although it's not readable, which is the main purpose of this package.

How unique, or reliable, can this package be to generate words as ID's?