Reference · Rules, tiles and records
judgeTilesfunction
Whether a grid is sound, read against the loaded word list by the game's rules: the same judgement the desk shows.
Import it
import { judgeTiles } from "@johnmorrisdotca/kumimoji";
Definition
function judgeTiles(tiles: Tiles, words: TileWords, rules?: GridRules): GridVerdict
Parameters
| Name | Type | Description |
|---|---|---|
tiles | Tiles | The map from row,column square names to internal tile codes. |
words | TileWords | The loaded native language word list and tile mappings. |
rules (optional) | GridRules | Whether diagonal runs are also judged. |
Returns
GridVerdict
Whether a grid is sound, read against the loaded word list by the game's rules: the same judgement the desk shows.
Examples
import { loadTileWordsFromModule } from "@johnmorrisdotca/kumimoji/words";
import { judgeTiles } from "@johnmorrisdotca/kumimoji";
const words = await loadTileWordsFromModule("english");
const tiles = new Map([["0,0","c"],["0,1","a"],["0,2","t"]]);
console.log(judgeTiles(tiles,words));{
sound: true,
tiles: 3,
misspelt: Set(0) {},
apart: Set(0) {},
notWords: []
}What it prints (run when this page was built)