Reference · Rules, games and records
formatResultfunction
The line that closes a game, with what it came to.
Import it
import { formatResult } from "@johnmorrisdotca/sugoroku";
Definition
function formatResult(result: GameResult): string
Parameters
| Name | Type | Description |
|---|---|---|
result | GameResult | The completed native game result to add to a match. |
Returns
string
The line that closes a game, with what it came to.
Examples
import { concede, formatResult, newGame, rollOpening, settingsFor } from "@johnmorrisdotca/sugoroku";
const settings = settingsFor("backgammon",{points:5,cube:true});
const game = rollOpening(newGame(settings),[3,1]);
const result = concede(game,"black","single").result!;
console.log(formatResult(result));result white concede single 1What it prints (run when this page was built)