Randofy JS

A JavaScript Utility library for math-related functions which allows you to easily create convincing randomly generated names, numbers, passwords, or any kind of dataset you wish to randomize.

Examples

Create Markov chains based on arbitrary dictionaries in order to create readable pseudo-random words.

Maybe you'd like to create a test bank generator that randomlizes and selects questions from a database. See a demo of this library in action here.

This library can be used from Node.js, or from the browser using the Browserify'd version in dist/randofy.js.

Usage

var Randofy = require('randofy');

// Create the Markov chain and specify the order of the chain.
// The order (an integer that is greater than 0) indicates how many previous letters are 
// taken into account when selecting the next one. A smaller order will
// result in a more randomized, less recognizeable output. Also, a
// higher order will result in words which resemble more closely to those
// in the original dictionary.
var chain = new Randofy(3);

// Add words into the Markov chain one at a time:
chain.addWordToChain("random");

//OR add all the words in an array at once:
var dictionary = ["hello","randofy"];
chain.addWordsToChain(dictionary);
  
// Generate a random word with a minimum of 5 characters, a maximum of 10 letters, 
// and that cannot be a match to any of the input dictionaries words.
//
// NOTE: If it is not possible to generate the desired word length from the input 
// dictionary, then this method will throw an Error after 25 failed attempts. This 
// can be customized by adding a final parameter to the method indicating the maximum 
// number of attempts to make when generating a word. 
//
//     e.g. chain.generateWord(5,10,false,100); for 100 attempts
//
var randomWord = chain.generateWord(5,10,false);

How to Contribute

Do you have a cool idea for a new snippet, or want to add your own tips? Checkout contributing.md.

Contributors:

Fred Siika Grace Nelore Simon Chong

Credits

Icon made by Smashicons from www.flaticon.com is licensed by CC 3.0 BY. This site was built using GitHub Pages.

License

Randofy.js is licensed under the MIT license.

⬆ Back to top