IBracketMatch
interface
Data & Models
A single match between two competitors. competitorA/B are nullable so the bracket can render "TBD" placeholders. scoreA/B accept string for non-numeric markers. nextMatchId lets OrigamBracket draw connectors automatically.
TypeScript
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- idrequisstring | number
- Stable identifier — required for connector linking.
- competitorArequisIBracketCompetitor | null
- Left-side / top-side competitor. null = TBD or bye.
- competitorBrequisIBracketCompetitor | null
- Right-side / bottom-side competitor. null = TBD or bye.
- scoreAnumber | string
- Score of competitorA. Accepts string for non-numeric markers.
- scoreBnumber | string
- Score of competitorB. Accepts string for non-numeric markers.
- winnerIdstring | number | null
- Identifier of the declared winner. Used to apply the --winner modifier class.
- statusTBracketMatchStatus
- Optional lifecycle marker. Drives the visual --status-{value} modifier on the match card.
- nextMatchIdstring | number
- Optional id of the downstream match this one feeds into — used by the connector layout.
- advantageIBracketMatchAdvantage
- Optional head-start for one competitor (double-elimination Grand Final advantage).
- scheduledAtstring
- ISO date string — informative only, displayed when present.
- metadataRecord<string, unknown>
- Free-form payload — never read by the component.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Defining a completed match