describeBracket関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The text a screen reader gets for the drawing as a whole, in the language of locale.
インポート
import { describeBracket } from "@johnmorrisdotca/taisen-brackets";定義
function describeBracket(input: BracketLayout | readonly Matchup[] | BracketInput, options?: Pick<DrawOptions, "locale" | "words" | "teamName" | "roundNames">): string引数
| 名前 | 型 | 説明 |
|---|---|---|
input | readonly Matchup[] | BracketInput | BracketLayout | The matchups, a |
options (省略可) | Pick<DrawOptions, "roundNames" | "locale" | "words" | "teamName"> | The language, words and round names. |
戻り値
string
The description.
例
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.出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。