Reference · Draw a bracket, a table or a road to the final
BoutBoardSourcetype
A bout to draw: the title, the phase, the bout number, the red and blue athletes and the officials.
Import it
import type { BoutBoardSource } from "@johnmorrisdotca/taisen-brackets";Definition
interface BoutBoardSource {
title: string;
phase?: string;
bout?: string | number;
red: BoutAthlete;
blue: BoutAthlete;
officials?: readonly BoutOfficial[];
}Members
| Name | Type | Description |
|---|---|---|
title | string | The event, in capitals in the title band ("Women's 57-60 kg"). |
phase (optional) | string | undefined | The phase, at the right of the title band ("Preliminaries"). |
bout (optional) | string | number | undefined | The bout's number ( |
red | BoutAthlete | The athlete in the red band, at the left, and the one in the blue band, at the right. |
blue | BoutAthlete | |
officials (optional) | readonly BoutOfficial[] | undefined | The referee and the judges, in the order they are written. |
Examples
import { boutBoard, type BoutBoardSource } from "@johnmorrisdotca/taisen-brackets";
const source: BoutBoardSource = {
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" }],
};
console.log(boutBoard(source).includes("BOUT: 142"));trueWhat it prints (run when this page was built)