Node Boggle Solver
Boggle is a game in which players try to find as many words as possible in a 4x4 grid of letters.
The default dictionary is SOWPODS and contains approximately 260,000 English words.
Pull down dependencies:
To run units tests:
To run linting:
npm run lint
Run tests in watch mode:
npm run test-watch
Get code coverage report:
npm run test-coverage
How to Use
To use the solver, install and save it to your package dependencies:
npm install node-boggle-solver --save
Instantiate the solver with the default dictionary or with a custom dictionary:
// pull in the modulevar boggle = ; // or import using ES2015 modules syntax; // instantiate and use the default dictionaryvar defaultSolver = ; // or use your own dictionaryvar customSolver = ;
The solver accepts grids of 3x3 and upwards. Letters can be lowercase , uppercase or space delimited. A callback function should be used to return any error and the solved data.
var boggle = ; // instantiate the solvervar solver = ; // solve a 3x3 gridsolver;solver;solver; // solve a 4x4 gridsolver; // solve a 5x5 gridsolver;
The first argument of the callback function is reserved for an error object. If an error occurs, it will be returned by the error argument.
The second argument is the data returned by the solver. It contains multiple properties and methods that act on the words found by the solver:
|An array of objects containing word found and corresponding co-ordinates in the board
|List of words found
|Checks if the passed in word is contained within the resulting word list
|Filters word list to words that contain any of the letters passed in
|Filters word list to words that start with the given prefix
|Filters word list to words that end with the given suffix
|Filters word list to the specified length
Copyright (c) 2017 Lyndsey Browning
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.