random-lorem

random-lorem

Return a semi-pronounceable random (nonsense) word.

Install

$ npm install --save random-lorem

Usage

For more use-cases see the tests

var randomLorem = require('random-lorem');

// API
// - randomLorem([options]);

// options
// - syllables
// - length
// - min
// - max

The word is returned in all lower case.

randomLorem();
// => 'tavnamgi'

Default is a word with a random number of syllables from 1 to 3.

This length is chosen as it works out to the average word length of ~5-6 chars which seems about right.

Can optionally specify a number of syllables which the word will have.

Note these are not syllables in the strict language definition of the word, but syllables as we’ve defined here which is 2 or 3 characters, mostly alternating between vowel and consanant. This is the about the best we can do with purely random generation.

randomLorem({ syllables: 3 });
// => 'tavnamgi'

Can optionally specify a length and the word will obey that bounding:

randomLorem({ length: 5 });
// => 'ralve'

In this case these two options are mutually exclusive, that is they cannot be combined as they often make no sense. It wouldn’t be possible to have a word with 7 syllables and a length of 5 or a length of 30 but 2 syllables.

Can optionally provide min and max, then with a random length:

randomLorem({ min: 2, max: 12 });
// => 'bappada'

Related

• random-syllable - Return a semi-speakable syllable, 2 or 3 letters.
• random-title - Return a random title populated by semi-pronounceable random (nonsense) words.
• random-sentence - Return a random sentence populated by semi-pronounceable random (nonsense) words.
• random-paragraph - Return a random paragraph generated from sentences populated by semi-pronounceable random (nonsense) words.

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.