Class StatisticsManager

Manages API operations related to player statistics and leaderboards.

Hierarchy (View Summary)

BaseManager
- StatisticsManager

Index

Constructors

Properties

Methods

forceWarmUp getAllSeasonStatistics getCurrentSeasonStatistics getLeaderboard getUserStatistics updateStatistics

Constructors

constructor

new StatisticsManager(client: RankedClient): StatisticsManager
Parameters
- client: RankedClient
Returns StatisticsManager
Inherited from BaseManager.constructor
- Defined in packages/sdk/src/managers/base.manager.ts:11

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

forceWarmUp

forceWarmUp(): Promise<{ message: string; success: boolean }>
Forces the backend to warm up the statistics cache for all ranked systems.

Returns Promise<{ message: string; success: boolean }>
A promise resolving to an object containing the success status and message.
- Defined in packages/sdk/src/managers/statistics/statistics.manager.ts:77

getAllSeasonStatistics

getAllSeasonStatistics(seasonId: string): Promise<StatisticsEntity[]>
Retrieves all statistics entries for a given season.
Parameters
- seasonId: string
  The unique identifier of the season.
Returns Promise<StatisticsEntity[]>
A promise resolving to an array of StatisticsEntity.
- Defined in packages/sdk/src/managers/statistics/statistics.manager.ts:39

getCurrentSeasonStatistics

getCurrentSeasonStatistics(
userId: number,
rankedSystemId: string,
): Promise<StatisticsEntity>
Retrieves the statistics for a user in the currently active season of a specific ranked system.
Parameters
- userId: number
  The internal database ID of the user.
- rankedSystemId: string
  The system identifier (e.g., 'bedwars-4v4').
Returns Promise<StatisticsEntity>
A promise resolving to a StatisticsEntity.
- Defined in packages/sdk/src/managers/statistics/statistics.manager.ts:29

getLeaderboard

getLeaderboard(
    seasonId: string,
    type: LeaderboardType,
    limit?: number,
): Promise<LeaderboardEntryEntity[]>
Retrieves the top players leaderboard for a specific season and metric.
Parameters
- seasonId: string
  The unique identifier of the season.
- type: LeaderboardType
  The metric to rank by (ELO, Wins, or MVPs).
- limit: number = 10
  Maximum number of players to return (defaults to 10).
Returns Promise<LeaderboardEntryEntity[]>
A promise resolving to an array of LeaderboardEntryEntity.
Example
```
const top10 = await client.statistics.getLeaderboard('season-1', LeaderboardType.ELO, 10);
console.log(`#1 is ${top10[0].ign} with ${top10[0].score} ELO!`);
```
- Defined in packages/sdk/src/managers/statistics/statistics.manager.ts:56

getUserStatistics

getUserStatistics(userId: number, seasonId: string): Promise<StatisticsEntity>
Retrieves the statistics for a specific user in a given season.
Parameters
- userId: number
  The internal database ID of the user.
- seasonId: string
  The unique identifier of the season.
Returns Promise<StatisticsEntity>
A promise resolving to a StatisticsEntity.
- Defined in packages/sdk/src/managers/statistics/statistics.manager.ts:18

updateStatistics

updateStatistics(dto: UpdateStatDto): Promise<StatisticsEntity>
Updates a user's statistics manually (e.g., adding a win or forcefully setting ELO).
Parameters
- dto: UpdateStatDto
  The payload containing the update instructions.
Returns Promise<StatisticsEntity>
A promise resolving to the updated StatisticsEntity.
- Defined in packages/sdk/src/managers/statistics/statistics.manager.ts:68