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

isVariantKeyfunction

Whether key names a variant.

Import it

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

Definition

function isVariantKey(key: unknown): key is VariantKey

Parameters

NameTypeDescription
keyunknown

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

Returns

boolean

Whether key names a variant.

Examples

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

console.log(isVariantKey("tabula"));
true

What it prints (run when this page was built)

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