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
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- idrequiredstring | number
- Stable identifier — required for connector linking.
- competitorArequiredIBracketCompetitor | null
- Left-side / top-side competitor. null = TBD or bye.
- competitorBrequiredIBracketCompetitor | 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.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Defining a completed match