Reference · Draw a bracket, a table or a road to the final
describeEntryListfunction
The entry list as a sentence, the drawing's description.
Import it
import { describeEntryList } from "@johnmorrisdotca/taisen-brackets";Definition
function describeEntryList(source: EntryListSource, options?: Pick<EntryListOptions, "locale" | "words" | "nameStyle" | "sort" | "precision">): stringParameters
| Name | Type | Description |
|---|---|---|
source | EntryListSource | The entry list. |
options (optional) | Pick<EntryListOptions, "locale" | "words" | "nameStyle" | "precision" | "sort"> | The language, the words, the name style and the sort. |
Returns
string
The description.
Examples
import { describeEntryList } from "@johnmorrisdotca/taisen-brackets";
console.log(describeEntryList({ category: "Men -66 kg", entries: [{ name: "Hoshino", rank: 3 }, { name: "Whitfield" }] }));Entry list. Men -66 kg. 1, Hoshino, Ranking 3. 2, Whitfield, NR.What it prints (run when this page was built)