Class Get

Hierarchy

BaseGetter
- Get

Constructors

constructor

new Get(storage): Get
Creates an instance of a Storage getter.
Parameters
- storage: Storage
  
  The implementation of Storage.
Returns Get
Inherited from BaseGetter.constructor
- Defined in src/base/getter.ts:16

Properties

`Protected` `Readonly` storage

storage: Storage

Methods

currentMatches

currentMatches(stageId): Promise<Match[]>
Returns the matches that can currently be played in parallel. If the stage doesn't contain any, an empty array is returned.

Note:
- Returned matches are ongoing (i.e. ready or running).
- Returned matches can be from different rounds.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<Match[]>
Example
If you don't know the stage id, you can first get the current stage.
```
const tournamentId = 3;
const currentStage = await manager.get.currentStage(tournamentId);
const currentMatches = await manager.get.currentMatches(currentStage.id);
```
- Defined in src/get.ts:140

currentRound

currentRound(stageId): Promise<null | Round>
Returns the round that is not completed yet, because of uncompleted matches. If all matches are completed in this stage of a tournament, there is no "current round", so null is returned.

Note: The consolation final of single elimination and the grand final of double elimination will be in a different Group.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<null | Round>
Example
If you don't know the stage id, you can first get the current stage.
```
const tournamentId = 3;
const currentStage = await manager.get.currentStage(tournamentId);
const currentRound = await manager.get.currentRound(currentStage.id);
```
- Defined in src/get.ts:105

currentStage

currentStage(tournamentId): Promise<null | Stage>
Returns the stage that is not completed yet, because of uncompleted matches. If all matches are completed in this tournament, there is no "current stage", so null is returned.
Parameters
- tournamentId: Id
  
  ID of the tournament.
Returns Promise<null | Stage>
- Defined in src/get.ts:73

`Private` doubleEliminationStandings

doubleEliminationStandings(stageId): Promise<FinalStandingsItem[]>
Returns the final standings of a double elimination stage.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<FinalStandingsItem[]>
- Defined in src/get.ts:311

`Private` eliminationSeeding

eliminationSeeding(stage): Promise<ParticipantSlot[]>
Returns the seeding of an elimination stage.
Parameters
- stage: Stage
  
  The stage.
Returns Promise<ParticipantSlot[]>
- Defined in src/get.ts:259

finalStandings

finalStandings(stageId): Promise<FinalStandingsItem[]>
Returns the final standings of a stage.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<FinalStandingsItem[]>
- Defined in src/get.ts:211

`Protected` findMatch

findMatch(groupId, roundNumber, matchNumber): Promise<Match>
Finds a match in a given group. The match must have the given number in a round of which the number in group is given.

Example: In group of id 1, give me the 4th match in the 3rd round.
Parameters
- groupId: Id
  
  ID of the group.
- roundNumber: number
  
  Number of the round in its parent group.
- matchNumber: number
  
  Number of the match in its parent round.
Returns Promise<Match>
Inherited from BaseGetter.findMatch
- Defined in src/base/getter.ts:581

`Protected` findMatchGame

findMatchGame(game): Promise<MatchGame>
Finds a match game based on its id or based on the combination of its parent_id and number.
Parameters
- game: {
      id?: Id;
      number?: number;
      opponent1?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; });
      opponent2?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; });
      parent_id?: Id;
      stage_id?: Id;
      status?: Status;
  }
  
  Values to change in a match game.
  - Optional id?: Id
    
    ID of the match game.
  - Optional number?: number
    
    The number of the match game in its parent match.
  - Optional opponent1?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; })
    
    First opponent of the match.
  - Optional opponent2?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; })
    
    Second opponent of the match.
  - Optional parent_id?: Id
    
    ID of the parent match.
  - Optional stage_id?: Id
    
    ID of the parent stage.
  - Optional status?: Status
    
    Status of the match.
Returns Promise<MatchGame>
Inherited from BaseGetter.findMatchGame
- Defined in src/base/getter.ts:604

`Protected` getLoserBracket

getLoserBracket(stageId): Promise<null | Group>
Gets the loser bracket.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<null | Group>
Inherited from BaseGetter.getLoserBracket
- Defined in src/base/getter.ts:542

`Protected` getNextMatches

getNextMatches(match, matchLocation, stage, roundNumber, roundCount): Promise<(null | Match)[]>
Gets the match(es) where the opponents of the current match will go just after.
Parameters
- match: Match
  
  The current match.
- matchLocation: GroupType
  
  Location of the current match.
- stage: Stage
  
  The parent stage.
- roundNumber: number
  
  The number of the current round.
- roundCount: number
  
  Count of rounds.
Returns Promise<(null | Match)[]>
Inherited from BaseGetter.getNextMatches
- Defined in src/base/getter.ts:265

`Protected` getOrderedRounds

getOrderedRounds(stage): Promise<Round[]>
Gets all the rounds that contain ordered participants.
Parameters
- stage: Stage
  
  The stage to get rounds from.
Returns Promise<Round[]>
Inherited from BaseGetter.getOrderedRounds
- Defined in src/base/getter.ts:25

`Protected` getPreviousMatches

getPreviousMatches(match, matchLocation, stage, roundNumber): Promise<Match[]>
Gets the matches leading to the given match.
Parameters
- match: Match
  
  The current match.
- matchLocation: GroupType
  
  Location of the current match.
- stage: Stage
  
  The parent stage.
- roundNumber: number
  
  Number of the round.
Returns Promise<Match[]>
Inherited from BaseGetter.getPreviousMatches
- Defined in src/base/getter.ts:90

`Protected` getRoundPositionalInfo

getRoundPositionalInfo(roundId): Promise<RoundPositionalInfo>
Gets the positional information (number in group and total number of rounds in group) of a round based on its id.
Parameters
- roundId: Id
  
  ID of the round.
Returns Promise<RoundPositionalInfo>
Inherited from BaseGetter.getRoundPositionalInfo
- Defined in src/base/getter.ts:69

`Protected` getSeedingMatches

getSeedingMatches(stageId, stageType): Promise<null | Match[]>
Returns the matches which contain the seeding of a stage based on its type.
Parameters
- stageId: Id
  
  ID of the stage.
- stageType: StageType
  
  The type of the stage.
Returns Promise<null | Match[]>
Inherited from BaseGetter.getSeedingMatches
- Defined in src/base/getter.ts:478

`Private` getStageSpecificData

getStageSpecificData(stageId): Promise<{
    groups: Group[];
    matchGames: MatchGame[];
    matches: Match[];
    rounds: Round[];
    stage: Stage;
}>
Returns only the data specific to the given stage (without the participants).
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<{
    groups: Group[];
    matchGames: MatchGame[];
    matches: Match[];
    rounds: Round[];
    stage: Stage;
}>
- Defined in src/get.ts:354

`Protected` getUpperBracket

getUpperBracket(stageId): Promise<Group>
Gets the upper bracket (the only bracket if single elimination or the winner bracket in double elimination).
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<Group>
Inherited from BaseGetter.getUpperBracket
- Defined in src/base/getter.ts:531

matchGames

matchGames(matches): Promise<MatchGame[]>
Returns the match games associated to a list of matches.
Parameters
- matches: Match[]
  
  A list of matches.
Returns Promise<MatchGame[]>
- Defined in src/get.ts:58

`Private` roundRobinSeeding

roundRobinSeeding(stage): Promise<ParticipantSlot[]>
Returns the seeding of a round-robin stage.
Parameters
- stage: Stage
  
  The stage.
Returns Promise<ParticipantSlot[]>
- Defined in src/get.ts:232

seeding

seeding(stageId): Promise<ParticipantSlot[]>
Returns the seeding of a stage.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<ParticipantSlot[]>
- Defined in src/get.ts:190

`Private` singleEliminationStandings

singleEliminationStandings(stageId): Promise<FinalStandingsItem[]>
Returns the final standings of a single elimination stage.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<FinalStandingsItem[]>
- Defined in src/get.ts:274

stageData

stageData(stageId): Promise<ValueToArray<DataTypes>>
Returns the data needed to display a stage.
Parameters
- stageId: Id
  
  ID of the stage.
Returns Promise<ValueToArray<DataTypes>>
- Defined in src/get.ts:13

tournamentData

tournamentData(tournamentId): Promise<ValueToArray<DataTypes>>
Returns the data needed to display a whole tournament with all its stages.
Parameters
- tournamentId: Id
  
  ID of the tournament.
Returns Promise<ValueToArray<DataTypes>>
- Defined in src/get.ts:34

`Static` `Protected` getSeedingOrdering

getSeedingOrdering(stageType, create): SeedOrdering
Returns the good seeding ordering based on the stage's type.
Parameters
- stageType: StageType
  
  The type of the stage.
- create: StageCreator
  
  A reference to a Create instance.
Returns SeedOrdering
Inherited from BaseGetter.getSeedingOrdering
- Defined in src/base/getter.ts:468

Class Get

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

storage: Storage

Returns Get

Properties

Protected Readonly storage

Methods

currentMatches

Parameters

stageId: Id

Returns Promise<Match[]>

Example

currentRound

Parameters

stageId: Id

Returns Promise<null | Round>

Example

currentStage

Parameters

tournamentId: Id

Returns Promise<null | Stage>

Private doubleEliminationStandings

Parameters

stageId: Id

Returns Promise<FinalStandingsItem[]>

Private eliminationSeeding

Parameters

stage: Stage

Returns Promise<ParticipantSlot[]>

finalStandings

Parameters

stageId: Id

Returns Promise<FinalStandingsItem[]>

Protected findMatch

Parameters

groupId: Id

roundNumber: number

matchNumber: number

Returns Promise<Match>

Protected findMatchGame

Parameters

Optional id?: Id

Optional number?: number

Optional opponent1?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; })

Optional opponent2?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; })

Optional parent_id?: Id

Optional stage_id?: Id

Optional status?: Status

Returns Promise<MatchGame>

Protected getLoserBracket

Parameters

stageId: Id

Returns Promise<null | Group>

Protected getNextMatches

Parameters

match: Match

matchLocation: GroupType

stage: Stage

roundNumber: number

roundCount: number

Returns Promise<(null | Match)[]>

Protected getOrderedRounds

Parameters

stage: Stage

Returns Promise<Round[]>

Protected getPreviousMatches

Parameters

match: Match

matchLocation: GroupType

stage: Stage

roundNumber: number

Returns Promise<Match[]>

Protected getRoundPositionalInfo

`Protected` `Readonly` storage

`Private` doubleEliminationStandings

`Private` eliminationSeeding

`Protected` findMatch

`Protected` findMatchGame

`Optional` id?: Id

`Optional` number?: number

`Optional` opponent1?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; })

`Optional` opponent2?: null | ({ id?: Id | null | undefined; position?: number | undefined; forfeit?: boolean | undefined; score?: number | undefined; result?: Result | undefined; })

`Optional` parent_id?: Id

`Optional` stage_id?: Id

`Optional` status?: Status

`Protected` getLoserBracket

`Protected` getNextMatches

`Protected` getOrderedRounds

`Protected` getPreviousMatches

`Protected` getRoundPositionalInfo

`Protected` getSeedingMatches

`Private` getStageSpecificData

Returns Promise<{
groups: Group[];
matchGames: MatchGame[];
matches: Match[];
rounds: Round[];
stage: Stage;
}>

`Protected` getUpperBracket

`Private` roundRobinSeeding

`Private` singleEliminationStandings

`Static` `Protected` getSeedingOrdering