Reference · Draw a bracket, a table or a road to the final
describeResultsBoardfunction
The board as a sentence, the drawing's description.
Import it
import { describeResultsBoard } from "@johnmorrisdotca/taisen-brackets";Definition
function describeResultsBoard(source: ResultsBoardSource, options?: Pick<ResultsBoardOptions, "locale" | "words" | "nameStyle" | "precision" | "ties" | "nameCase">): stringParameters
| Name | Type | Description |
|---|---|---|
source | ResultsBoardSource | The results. |
options (optional) | Pick<ResultsBoardOptions, "locale" | "words" | "nameStyle" | "precision" | "ties" | "nameCase"> | The language, the words, the name style, the precision, ties and name case. |
Returns
string
The description.
Examples
import { describeResultsBoard } from "@johnmorrisdotca/taisen-brackets";
console.log(describeResultsBoard({
title: "Men's 100m butterfly",
phase: "Results · Final",
columns: [{ precision: 2 }],
rows: [
{ code: "USA", flag: "US", name: "Michael Phillips", values: [50.58], record: "OR" },
{ code: "HUN", flag: "HU", name: "Laszlo Czigany", values: [50.59] },
],
}));Men's 100m butterfly. Results · Final. 1, Michael Phillips, USA, 50.58, OR. 2, Laszlo Czigany, HUN, 50.59.What it prints (run when this page was built)