Reference · Marking, scores and game rules
guessMarksfunction
How each place of a guess did against the hidden word. For letters wrongSize and wrongMark are false.
Import it
import { guessMarks } from "@johnmorrisdotca/kotoba";
Definition
function guessMarks(game: Pick<WordGame, "language" | "hidden">, guess: string): PlaceMark[]
Parameters
| Name | Type | Description |
|---|---|---|
game | Pick<WordGame, "hidden" | "language"> | The current immutable word-game state. |
guess | string | The guessed word or kana array, with the same length as the hidden word. |
Returns
PlaceMark[]
How each place of a guess did against the hidden word. For letters wrongSize and wrongMark are false.
Examples
import { guessMarks, startWordGame } from "@johnmorrisdotca/kotoba";
const game = startWordGame("en",5,"apple");
console.log(guessMarks(game,"alley"));[
{ mark: 'hit', wrongSize: false, wrongMark: false },
{ mark: 'near', wrongSize: false, wrongMark: false },
{ mark: 'miss', wrongSize: false, wrongMark: false },
{ mark: 'near', wrongSize: false, wrongMark: false },
{ mark: 'miss', wrongSize: false, wrongMark: false }
]What it prints (run when this page was built)