LeaderboardsController | @dhealthdapps/backend

label

STATISTICS

description

The leaderboards controller of the app. Handles requests about leaderboards that are available in the database.

This controller defines the following routes:

URI	HTTP method	Class method	Description
`/statistics/leaderboards`	`GET`	LeaderboardsController.find	Responds with a pageable PaginatedResultDTO that contains StatisticsDTO objects.

since

v0.3.2

Hierarchy

LeaderboardsController

Index

Constructors

constructor

Methods

Constructors

constructor

new LeaderboardsController(authService: AuthService, statisticsService: StatisticsService): LeaderboardsController

- Defined in src/statistics/routes/LeaderboardsController.ts:103
Constructs an instance of this controller.

Parameters
- authService: AuthService
- statisticsService: StatisticsService
Returns LeaderboardsController

Methods

Protected find

find(query: StatisticsQuery): Promise<PaginatedResultDTO<StatisticsDTO>>

- Defined in src/statistics/routes/LeaderboardsController.ts:131
Handler of the /statistics/leaderboard endpoint. Returns all leaderboards that match the request query. If the query is null or not specified, returns all documents in DTO format using StatisticsDTO.

The result of this endpoint can be paginated using query parameters: pageSize, pageNumber. Also, it can be sorted with query parameters: sort, order.

method
GET

access
protected

async
Parameters
- query: StatisticsQuery
Returns Promise<PaginatedResultDTO<StatisticsDTO>>

Protected findByUser

findByUser(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>, query: StatisticsQuery): Promise<StatisticsDTO>

- Defined in src/statistics/routes/LeaderboardsController.ts:181
Requests a user's leaderboard entries. This endpoint is protected and a valid access token must be attached in the Authorization request header, in signed cookies or in browser cookies.

The request is secured using the AuthGuard guard which attaches a payload to the request object.

method
GET

access
protected

async
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  
  An express request used to extract the authenticated user payload.
- query: StatisticsQuery
Returns Promise<StatisticsDTO>
An authenticated user's owned assets.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

authService: AuthService

statisticsService: StatisticsService

Returns LeaderboardsController

Methods

Protected find

Parameters

query: StatisticsQuery

Returns Promise<PaginatedResultDTO<StatisticsDTO>>

Protected findByUser

Parameters

req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

query: StatisticsQuery

Returns Promise<StatisticsDTO>