Reference · Rules, games and records
settingsForfunction
Settings from a variant key (or a row) and rules, left-out rules filled in.
Import it
import { settingsFor } from "@johnmorrisdotca/sugoroku";
Definition
function settingsFor(variant: VariantKey | VariantSpec, rules?: Partial<Rules>): Settings
Parameters
| Name | Type | Description |
|---|---|---|
variant | VariantKey | VariantSpec | The variant key or resolved specification. |
rules (optional) | Partial<Rules> | The complete or partial native rules specified by the signature. |
Returns
Settings
Settings from a variant key (or a row) and rules, left-out rules filled in.
Examples
import { settingsFor } from "@johnmorrisdotca/sugoroku";
console.log(settingsFor("nackgammon",{points:5}).variant.key);nackgammonWhat it prints (run when this page was built)