Reference · Draw a bracket, a table or a road to the final
describeJudoQueuefunction
The mat queue as a sentence: for each mat, its contests in order.
Import it
import { describeJudoQueue } from "@johnmorrisdotca/taisen-brackets";Definition
function describeJudoQueue(mats: JudoMat | readonly JudoMat[], options?: Pick<JudoBoardOptions, "locale" | "words">): stringParameters
| Name | Type | Description |
|---|---|---|
mats | JudoMat | readonly JudoMat[] | One mat or a list of mats. |
options (optional) | Pick<JudoBoardOptions, "locale" | "words"> | The language and the words. |
Returns
string
The description.
Examples
import { describeJudoQueue } from "@johnmorrisdotca/taisen-brackets";
console.log(describeJudoQueue({ mat: 1, contests: [{ number: "G-1", white: { name: "Daiki Hoshino" }, blue: { name: "Mathis Roussel" } }] }));Mat 1: G-1 Daiki Hoshino (white) v Mathis Roussel (blue).What it prints (run when this page was built)