playShiritori関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
Judges one word against the readings played so far.
インポート
import { playShiritori } from "@johnmorrisdotca/kotoba";
定義
function playShiritori(played: readonly string[], reading: string, rules?: ShiritoriRules): ShiritoriPlay
引数
| 名前 | 型 | 説明 |
|---|---|---|
played | readonly string[] | The readings so far, oldest first; empty for the first word. |
reading | string | The reading of the word now said. |
rules (省略可) | ShiritoriRules | House rules; the forgiving ones if left out. |
戻り値
ShiritoriPlay
Whether the word stands, where it leaves the chain, or why it was refused.
例
import { playShiritori } from "@johnmorrisdotca/kotoba";
console.log(playShiritori(["さくら"], "らくだ"), playShiritori(["さくら"], "いぬ"), playShiritori(["さくら"], "らいおん"));{ ok: true, loses: false, next: 'た' } { ok: false, why: 'wrong-start' } { ok: true, loses: true, next: null }出力(このページを作ったときに実行した結果)
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。