describeMatchup関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The card as a sentence, the drawing's description.
インポート
import { describeMatchup } from "@johnmorrisdotca/taisen-brackets";定義
function describeMatchup(source: MatchupSource, options?: Pick<MatchupOptions, "locale" | "words" | "nameStyle" | "precision" | "rankStyle">): string引数
| 名前 | 型 | 説明 |
|---|---|---|
source | MatchupSource | The matchup. |
options (省略可) | Pick<MatchupOptions, "locale" | "words" | "nameStyle" | "precision" | "rankStyle"> | The language, the words, the name style, the precision and the rank style. |
戻り値
string
The description.
例
import { describeMatchup } from "@johnmorrisdotca/taisen-brackets";
console.log(describeMatchup({ a: { name: "Nakamura", rank: 1 }, b: { name: "Brar", rank: 2 }, meetings: [
{ date: "2026-09-13", event: "Fall Open", round: "Semi-final", winner: 0, result: "ippon · 2:11" },
{ date: "2026-05-17", event: "Spring Classic", round: "Final", winner: 1, result: "waza-ari · golden score" },
] }));Head to head: Nakamura v Brar. Nakamura, Ranking 1. Brar, Ranking 2. Previous meetings 1–1. Sep 13, 2026, Fall Open Semi-final, Nakamura, ippon · 2:11. May 17, 2026, Spring Classic Final, Brar, waza-ari · golden score.出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。