The leaderboard-api leaderboard controller module.
- Version:
- 1.0.0
- Source:
Methods
(async, static) getActAllMiddleware(req, res) → {Promise}
Router-level middleware function for the endpoint /leaderboard/:activity.
Parameters:
| Name | Type | Description |
|---|---|---|
req |
object | The request object. |
res |
object | The response object. |
- Source:
Requires:
- module:redis-leaderboard.LeaderBoard.getActivity
Returns:
- Type
- Promise
(async, static) getActTopMiddleware(req, res) → {Promise}
Router-level middleware function for the endpoint /leaderboard/:activity/top[/:count].
Parameters:
| Name | Type | Description |
|---|---|---|
req |
object | The request object. |
res |
object | The response object. |
- Source:
Requires:
- module:redis-leaderboard.LeaderBoard.getActivityTopUsers
Returns:
- Type
- Promise
(async, static) getActUsrMiddleware(req, res) → {Promise}
Router-level middleware function for the endpoint /leaderboard/:activity/user/:username.
Parameters:
| Name | Type | Description |
|---|---|---|
req |
object | The request object. |
res |
object | The response object. |
- Source:
Requires:
- module:redis-leaderboard.LeaderBoard.getUserScoreAndRank
Returns:
- Type
- Promise
(async, static) getAllMiddleware(req, res) → {Promise}
Router-level middleware function for the endpoint /leaderboard/global.
Parameters:
| Name | Type | Description |
|---|---|---|
req |
object | The request object. |
res |
object | The response object. |
- Source:
Requires:
- module:redis-leaderboard.LeaderBoard.getActivities
Returns:
- Type
- Promise
(async, static) getTopMiddleware(req, res) → {Promise}
Router-level middleware function for the endpoint /leaderboard/global/top[/:count].
Parameters:
| Name | Type | Description |
|---|---|---|
req |
object | The request object. |
res |
object | The response object. |
- Source:
Requires:
- module:redis-leaderboard.LeaderBoard.getActivities
Returns:
- Type
- Promise
(async, static) getUsrMiddleware(req, res) → {Promise}
Router-level middleware function for the endpoint /leaderboard/global/user/:username.
Parameters:
| Name | Type | Description |
|---|---|---|
req |
object | The request object. |
res |
object | The response object. |
- Source:
Requires:
- module:redis-leaderboard.LeaderBoard.getUserActivities
Returns:
- Type
- Promise