`WordGame`型

リファレンスの説明と例は英語です。見出しと目次は日本語です。

A round.

インポート

import type { WordGame } from "@johnmorrisdotca/kotoba";

定義

type WordGame = {
    language: WordGameLanguage;
    size: number;
    rows: number;
    hidden: string;
    guesses: readonly string[];
    typed: readonly string[];
    pending: string;
    status: WordGameStatus;
    startedAt: number | null;
    score: WordScore | null;
};

メンバー

名前	型	説明
`language`	`WordGameLanguage`
`size`	`number`	How many letters, or kana, the word has.
`rows`	`number`	How many guesses the round gives.
`hidden`	`string`	The word to find.
`guesses`	`readonly string[]`	The guesses made, each a whole word.
`typed`	`readonly string[]`	The letters, or kana, of the guess being typed.
`pending`	`string`	Romaji typed and not yet a kana: `k` waiting for a vowel. Always empty for letters.
`status`	`WordGameStatus`
`startedAt`	`number \| null`	When the first key was pressed, in milliseconds, or null before it.
`score`	`WordScore \| null`	The score, once the round is over.

例

import { startWordGame } from "@johnmorrisdotca/kotoba";
import type { WordGame } from "@johnmorrisdotca/kotoba";

const game = startWordGame("en",5,"apple");
const value: WordGame = game;
console.log(value);

{
  language: 'en',
  size: 5,
  rows: 6,
  hidden: 'apple',
  guesses: [],
  typed: [],
  pending: '',
  status: 'playing',
  startedAt: null,
  score: null
}

出力（このページを作ったときに実行した結果）

ソースを見る GitHub で編集@johnmorrisdotca/kotoba 1.2.0 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。

WordGame型

定義

メンバー

例

`WordGame`型