describeResultsBoard関数
リファレンスの説明と例は英語です。見出しと目次は日本語です。
The board as a sentence, the drawing's description.
インポート
import { describeResultsBoard } from "@johnmorrisdotca/taisen-brackets";定義
function describeResultsBoard(source: ResultsBoardSource, options?: Pick<ResultsBoardOptions, "locale" | "words" | "nameStyle" | "precision" | "ties" | "nameCase">): string引数
| 名前 | 型 | 説明 |
|---|---|---|
source | ResultsBoardSource | The results. |
options (省略可) | Pick<ResultsBoardOptions, "locale" | "words" | "nameStyle" | "precision" | "ties" | "nameCase"> | The language, the words, the name style, the precision, ties and name case. |
戻り値
string
The description.
例
import { describeResultsBoard } from "@johnmorrisdotca/taisen-brackets";
console.log(describeResultsBoard({
title: "Men's 100m butterfly",
phase: "Results · Final",
columns: [{ precision: 2 }],
rows: [
{ code: "USA", flag: "US", name: "Michael Phillips", values: [50.58], record: "OR" },
{ code: "HUN", flag: "HU", name: "Laszlo Czigany", values: [50.59] },
],
}));Men's 100m butterfly. Results · Final. 1, Michael Phillips, USA, 50.58, OR. 2, Laszlo Czigany, HUN, 50.59.出力（このページを作ったときに実行した結果）
この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。