From 5fae4de945f3631a9fb46dd08a2a1f81d6b0dfa3 Mon Sep 17 00:00:00 2001 From: Fascinated Date: Wed, 29 Mar 2023 21:27:15 +0100 Subject: [PATCH] update docs --- src/scoresaber/ScoreSaber.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/scoresaber/ScoreSaber.ts b/src/scoresaber/ScoreSaber.ts index c07470a..5a2c115 100644 --- a/src/scoresaber/ScoreSaber.ts +++ b/src/scoresaber/ScoreSaber.ts @@ -25,7 +25,7 @@ enum PlayerDataType { * @param page the page number * @param countries the countries to search * @param withMetadata whether to include metadata - * @returns the players + * @returns {ScoresaberPlayerSearch} the players */ export async function getPlayers( search: string, @@ -45,7 +45,7 @@ export async function getPlayers( /** * Gets the number of active players on ScoreSaber * - * @returns the number of active players + * @returns {number} the number of active players */ export async function getActivePlayerCount(): Promise { const url = `${CONSTS.BASE_URL}/${CONSTS.PLAYER_COUNT}`; @@ -58,7 +58,7 @@ export async function getActivePlayerCount(): Promise { * * @param playerId the players id (not the name) * @param type the type of data to get - * @returns the player data + * @returns {ScoresaberPlayer} the player data */ export async function getPlayer( playerId: string,