Skip to content

hachi-studio/wordice

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wordice 🎲

Generate random words, or pick some from an array!

Got an array of words and need something randomly selected? Wordice picks a random word (or words) from an array with ease!

Don't have an array, and just need a random word? We got you.

Demo: here

Installation:

yarn add wordice

Usage:


wordice(['Bird', 'Is', 'The', 'Word']); // Your own array
wordice(['Bird', 'Is', 'The', 'Word'], options); // Your own array + options!
wordice(); // Uses a default list of words

Examples:

Default:

import wordice from "wordice";

const myRandomWord = wordice();
console.log(myRandomWord);
// Duck

With your own array:

import wordice from "wordice";

const coolArray = ['This', 'Is', 'An', 'Array', 'Of', 'Words'];
const myRandomWord = wordice(coolArray);
console.log(myRandomWord);
// Of

You can supply options for minimum characters, max characters and amount of words you want returned

Note: If you set wordCount to a greater number of items in the array it will be capped at the length of the array, see allowDuplicates below.

import wordice from "wordice";

const coolArray = ['This', 'Is', 'An', 'Array', 'Of', 'Some', 'More', 'Words'];
const myRandomWords = wordice(coolArray, { minCharacters: 3, maxCharacters: 4, wordCount: 3 });
console.log(myRandomWords);
// More, Some, This

You can change also allow the return of duplicated words, allowing you to set a higher wordCount value than length of the array.

import wordice from "wordice";

const coolArray = ['A', 'B', 'C'];
const myRandomWords = wordice(coolArray, { allowDuplicates: true, wordCount:  });
console.log(myRandomWords);
// C,B,C,A,A

You can change the joining character between items

import wordice from "wordice";

const coolArray = ['This', 'Is', 'An', 'Array', 'Of', 'Some', 'More', 'Words'];
const myRandomWords = wordice(coolArray, { join: '-' wordCount: 3 });
console.log(myRandomWords);
// Words-Some-This

In the wild

Passnip password generator

Feedback:

Feel free to send us file an issue or add feedback here. Feature requests are always welcome.

About

Simply grab some random words from an array!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published