Reference · Draw a bracket, a table or a road to the final
describeBracketfunction
The text a screen reader gets for the drawing as a whole, in the language of locale.
Import it
import { describeBracket } from "@johnmorrisdotca/taisen-brackets";Definition
function describeBracket(input: BracketLayout | readonly Matchup[] | BracketInput, options?: Pick<DrawOptions, "locale" | "words" | "teamName" | "roundNames">): stringParameters
| Name | Type | Description |
|---|---|---|
input | readonly Matchup[] | BracketInput | BracketLayout | The matchups, a |
options (optional) | Pick<DrawOptions, "roundNames" | "locale" | "words" | "teamName"> | The language, words and round names. |
Returns
string
The description.
Examples
import { describeBracket } from "@johnmorrisdotca/taisen-brackets";
console.log(describeBracket([{ sides: ["Aurora", "Harbour"], score: [2, 1] }, { sides: ["Cascade", "Delta"], score: [0, 1] }, { sides: ["Aurora", "Delta"], score: [3, 1] }]));4 teams, 2 rounds. Final: Aurora 3, Delta 1. Winner: Aurora. Champion: Aurora.What it prints (run when this page was built)