1.0.1 • Published 6 years ago

worge v1.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago

Worge

Word + Merge = Worge

Easy and simple word merging based off of other words

Basic Usage

const worge = require('worge');

console.log(worge({}));
// ['']

console.log(worge({ words: ['Word', 'Merge'], threshhold: 1 }));
// ['Worge']
// Other possibilities ['Merd'], ['Word'], or ['Merge']

Worge Parameters

ParameterTypeDefaultUse
wordsArray The pool of words to attempt to merge
thresholdNumber3The amount of letters needed to match to merge
countNumber1How many unique words
maxLengthNumber16Max length of unique words
failsThresholdNumber10How many times worge will attempt to find a new word before returning the current array

License

This project is licensed under the MIT License - see the LICENSE file for details

1.0.1

6 years ago

1.0.0

6 years ago