Class Tournament

Stateful chess tournament orchestrator. Drives any pairing system through a common lifecycle: create, pair, record results, standings, repeat.

Follows the PositionData / Position pattern: TournamentData is the plain data interface, Tournament is the class that wraps it.

Example

import { Tournament } from '@echecs/tournament';
import { dutch } from '@echecs/swiss';

const t = new Tournament(
  {
    completedRounds: [],
    players: [
      { id: 'alice', points: 0, rank: 1 },
      { id: 'bob', points: 0, rank: 2 },
      { id: 'carol', points: 0, rank: 3 },
      { id: 'dave', points: 0, rank: 4 },
    ],
    totalRounds: 3,
  },
  { pairingSystem: dutch },
);

const r1 = t.pair();
// record results...
const standings = t.standings();

Index

Constructors

constructor

new Tournament(
    data: TournamentData,
    options: {
        acceleration?: AccelerationMethod;
        onTrace?: TraceCallback;
        onWarning?: (message: string) => void;
        pairingSystem: PairingSystem;
        tiebreaks?: Record<string, Tiebreak>;
    },
): Tournament
Creates a new tournament.
Parameters
- data: TournamentData
  Tournament data.
- options: {
      acceleration?: AccelerationMethod;
      onTrace?: TraceCallback;
      onWarning?: (message: string) => void;
      pairingSystem: PairingSystem;
      tiebreaks?: Record<string, Tiebreak>;
  }
  Pairing system and optional acceleration method.
Returns Tournament
- Defined in tournament.ts:149

Accessors

completedRounds

get completedRounds(): readonly CompletedRound[]
All completed rounds.

Returns readonly CompletedRound[]
- Defined in tournament.ts:190

currentRound

get currentRound(): Round | undefined
The current round in progress, if any.

Returns Round | undefined
- Defined in tournament.ts:195

isComplete

get isComplete(): boolean
Whether all rounds have been completed.

Returns boolean
- Defined in tournament.ts:200

metadata

get metadata(): TournamentMetadata | undefined
Tournament metadata (report info, auto-logged comments).

Returns TournamentMetadata | undefined
- Defined in tournament.ts:208

players

get players(): readonly Player[]
All registered players (including withdrawn).

Returns readonly Player[]
- Defined in tournament.ts:213

totalRounds

get totalRounds(): number
Total number of rounds in the tournament.

Returns number
- Defined in tournament.ts:218

Methods

adjust

adjust(adjustment: PointAdjustment): void
Adds a point adjustment (penalty, bonus). Affects standings. Logs a comment in metadata.
Parameters
- adjustment: PointAdjustment
Returns void
- Defined in tournament.ts:252

clear

clear(round: number, white: string, black: string): void
Removes a result, reverting a game back to a pairing.
Parameters
- round: number
  The 1-based round number.
- white: string
  Player identifier for white.
- black: string
  Player identifier for black.
Returns void
Throws
If the round is invalid or no matching game exists.
- Defined in tournament.ts:274

correct

correct(round: number, game: Game): void
Corrects a result in any round (including completed). Logs a comment. Handles adjourned games (FIDE C.04.2 Art 3.1).
Parameters
- round: number
  The 1-based round number.
- game: Game
  The corrected game result.
Returns void
Throws
If the round is invalid or no matching pairing exists.
- Defined in tournament.ts:341

enter

enter(player: Player): void
Late entry (FIDE C.04.2 Art 2.4). Player joins with their specified points for missed rounds, paired from next pair() call.
Parameters
- player: Player
Returns void
- Defined in tournament.ts:440

pair

pair(): Pairings
Generates pairings for the next round using the injected pairing system. If a current round exists and all games are complete, promotes it to completedRounds before pairing the next round.

Returns Pairings
The pairings and byes for the new round.

Throws
If the tournament is complete or the current round has unrecorded results.
- Defined in tournament.ts:458

record

record(game: Game): void
Records a result for a pairing in the current round. Validates the pairing exists. Results accumulate on currentRound. The round is promoted to completedRounds by the next pair() call.
Parameters
- game: Game
  The game result to record.
Returns void
Throws
If no round has been paired or the players don't match any pairing.
- Defined in tournament.ts:520

standings

standings(tiebreaks?: Tiebreak[]): Standing[]
Returns players ranked by score descending, with optional tiebreaks applied in order. Scoring uses the tournament's ScoringSystem.
Parameters
- Optionaltiebreaks: Tiebreak[]
  Ordered array of tiebreak functions.
Returns Standing[]
Sorted standings array.
- Defined in tournament.ts:562

toJSON

toJSON(): TournamentData
Serializes the tournament state to a plain object suitable for JSON.stringify.

Returns TournamentData
- Defined in tournament.ts:623

withdraw

withdraw(playerId: string): void
Player leaves. No longer paired (FIDE C.04.2 Art 3.2).
Parameters
- playerId: string
Returns void
- Defined in tournament.ts:646

Class Tournament

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Tournament

Accessors

completedRounds

Returns readonly CompletedRound[]

currentRound

Returns Round | undefined

isComplete

Returns boolean

metadata

Returns TournamentMetadata | undefined

players

Returns readonly Player[]

totalRounds

Returns number

Methods

adjust

Parameters

Returns void

clear

Parameters

Returns void

Throws

correct

Parameters

Returns void

Throws

enter

Parameters

Returns void

pair

Returns Pairings

Throws

record

Parameters

Returns void

Throws

standings

Parameters

Returns Standing[]

toJSON

Returns TournamentData

withdraw

Parameters

Returns void

Settings

On This Page