Skip to content

dovid-moshe-crow/make-words

Repository files navigation

make-words

generate random words Node.js Package Codacy Badge npm version

Installation

Use the package manager npm to install make-words.

npm i make-words

Functions

getWordByLength(length)string

get all words thet have a specific length

getRandomWord()string

get a random word from the dataset

getWord(length, letters, excludeChars, [mustHaveLetter])

get a word that has a specific length and that includes the most letters possible from the letters array

getWords(count, minWordLength, maxWordLength, letters, excludeChars, [mustHaveLetter])

get any number of random words that contain specific letters

getWordByLength(length) ⇒ string

get all words thet have a specific length

Kind: global function

Param Type
length number

getRandomWord() ⇒ string

get a random word from the dataset

Kind: global function

getWord(length, letters, excludeChars, [mustHaveLetter])

get a word that has a specific length and that includes the most letters possible from the letters array

Kind: global function

Param Type
length number
letters Array.<string>
excludeChars Array.<string>
[mustHaveLetter] string

getWords(count, minWordLength, maxWordLength, letters, excludeChars, [mustHaveLetter])

get any number of random words that contain specific letters

Kind: global function

Param Type
count number
minWordLength number
maxWordLength number
letters Array.<string>
excludeChars Array.<string>
[mustHaveLetter] string

License

MIT

About

generate random words

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors