Reference · Draw a bracket, a table or a road to the final
describeJudoRoadfunction
The road as a sentence, the drawing's description.
Import it
import { describeJudoRoad } from "@johnmorrisdotca/taisen-brackets";Definition
function describeJudoRoad(source: JudoRoadSource, options?: Pick<JudoRoadOptions, "locale" | "words" | "weight" | "order">): stringParameters
| Name | Type | Description |
|---|---|---|
source | JudoRoadSource | The athlete and their wins. |
options (optional) | Pick<JudoRoadOptions, "locale" | "words" | "weight" | "order"> | The language, the words, the weight class and the order. |
Returns
string
The description.
Examples
import { describeJudoRoad, judoWins } from "@johnmorrisdotca/taisen-brackets";
console.log(describeJudoRoad({ athlete: { name: "Haru" }, wins: judoWins([
{ id: "a", round: 1, sides: ["Haru", "Marc"], judo: { sides: [{ ippon: true }, {}], time: "1:12" } },
{ id: "f", round: 2, sides: ["Haru", "Levan"], judo: { sides: [{ wazaAri: 1 }, { yuko: 1 }], goldenScore: true, time: "5:40" } },
], "Haru") }));Road to the final: Haru. Final: Levan (decision · GS · 5:40). Semi-finals: Marc (ippon · 1:12).What it prints (run when this page was built)