Reference · Draw a bracket, a table or a road to the final
describeBoutBoardfunction
The board as a sentence, the drawing's description.
Import it
import { describeBoutBoard } from "@johnmorrisdotca/taisen-brackets";Definition
function describeBoutBoard(source: BoutBoardSource, options?: Pick<BoutBoardOptions, "locale" | "words" | "nameStyle" | "nameCase">): stringParameters
| Name | Type | Description |
|---|---|---|
source | BoutBoardSource | The bout. |
options (optional) | Pick<BoutBoardOptions, "locale" | "words" | "nameStyle" | "nameCase"> | The language, the words, the name style and case. |
Returns
string
The description.
Examples
import { describeBoutBoard } from "@johnmorrisdotca/taisen-brackets";
console.log(describeBoutBoard({
title: "Women's 57-60 kg",
phase: "Preliminaries",
bout: 142,
red: { code: "BRA", flag: "BR", name: "TAVARES M." },
blue: { code: "USA", flag: "US", name: "MAYER M." },
officials: [{ role: "referee", code: "MGL", flag: "MN", name: "KHISHIGEE Khas-Erdene" }, { code: "POL", flag: "PL", name: "GORNY Mariusz" }],
}));Women's 57-60 kg. Preliminaries. Bout presentation: Bout: 142. TAVARES M. (BRA) v MAYER M. (USA). Referee and judges: Referee KHISHIGEE Khas-Erdene (MGL), Judge 1 GORNY Mariusz (POL).What it prints (run when this page was built)