Skip to the content

Sugoroku双六

Play backgammon and its relatives with native rules, cube and match scoring, seeded dice and replayable records.

Sugoroku is the Japanese name 双六 for games of tables. About the name

Contents

Reference · Rules, games and records

presetByKeyfunction

The preset with this key, or undefined.

Import it

import { presetByKey } from "@johnmorrisdotca/sugoroku";

Definition

function presetByKey(key: string): Preset | undefined

Parameters

NameTypeDescription
keystring

The native variant, preset or localized-label key specified by the signature.

Returns

Preset | undefined

The matching preset, or undefined for an unknown key.

Examples

import { PRESETS, presetByKey } from "@johnmorrisdotca/sugoroku";

console.log(presetByKey(PRESETS[0].key)?.names);
[
  'Backgammon',
  'Backgammon Level 2',
  'Backgammon Level 3',
  'Casual Backgammon'
]

What it prints (run when this page was built)

View sourceEdit on GitHubMade from the source of @johnmorrisdotca/sugoroku 1.1.1.