Skip to main content
The Tournament type contains metadata about the current tournament and match being played.

Type Definition

type Tournament = {
    name: string,
    match: string,
    phase: string,
    bestOf: number,
}

Fields

name
string
required
Full tournament name (e.g., “Genesis 9”, “Super Smash Con 2023”)
match
string
required
Match identifier from the bracket (e.g., “Winners Finals”, “Losers Round 2”, “Grand Finals”)
phase
string
required
Tournament phase or pool (e.g., “Top 8”, “Pool A”, “Championship Bracket”)
bestOf
number
required
Best-of format for the match (e.g., 3 for Bo3, 5 for Bo5)

Example

{
  "name": "Genesis 9",
  "match": "Winners Finals",
  "phase": "Top 8",
  "bestOf": 5
}

Build docs developers (and LLMs) love