Reference · Rules, tiles and records
KumimojiExportedtype
A whole JSON export of one game: what kumimojiToJSON writes and kumimojiFromJSON reads.
Import it
import type { KumimojiExported } from "@johnmorrisdotca/kumimoji";
Definition
type KumimojiExported = {
format: typeof KUMIMOJI_EXPORT_FORMAT;
game: "kumimoji";
generator: string;
size: number;
level: KumimojiLevel;
seed: number;
language: KumimojiLanguage;
gameLength: KumimojiLength;
doubleSet: boolean;
diagonals: boolean;
progress: string;
elapsedMs: number;
};
Members
| Name | Type | Description |
|---|---|---|
format | 1 | The shape's number: |
game | "kumimoji" | Always |
generator | string | The package and version that wrote it, such as |
size | number | The opening hand: 3, 7 or 11. |
level | KumimojiLevel | How many of the tiles are wild. |
seed | number | The seed the bag is dealt from. |
language | KumimojiLanguage | The language of the tiles. |
gameLength | KumimojiLength | How much of the set the bag holds. |
doubleSet | boolean | Two English sets at once. |
diagonals | boolean | Whether diagonal runs of three or more must be words too. |
progress | string | Where the player has got to, as |
elapsedMs | number | Milliseconds spent so far. |
Examples
import { deal, generateKumimoji, kumimojiExported } from "@johnmorrisdotca/kumimoji";
import type { KumimojiExported } from "@johnmorrisdotca/kumimoji";
import { loadTileWordsFromModule } from "@johnmorrisdotca/kumimoji/words";
await loadTileWordsFromModule("english");
const play = deal("catdog",3);
const dealt = generateKumimoji(3,"hard",44);
const saved = {deal:dealt,play:deal(dealt.givens,dealt.size),elapsedMs:0};
const value: KumimojiExported = kumimojiExported(saved);
console.log(value);{
format: 1,
game: 'kumimoji',
generator: 'kumimoji 1.6.0',
size: 3,
level: 'hard',
seed: 44,
language: 'english',
gameLength: 'short',
doubleSet: false,
diagonals: false,
progress: '3::nwo:',
elapsedMs: 0
}What it prints (run when this page was built)