Fascinated/beatsaber-helpers
Archived
1
0
Fork 0
Code Issues Pull Requests 1 Actions Projects Wiki Activity

update docs
All checks were successful
build (15.x)
Details
build (16.x)
Details
build (17.x)
Details
build (18.x)
Details
build (19.x)
Details

Browse Source
This commit is contained in:
Lee 2023-03-29 21:27:15 +01:00
parent c8bcd90089
commit 5fae4de945
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/scoresaber/ScoreSaber.ts
View File

@ -25,7 +25,7 @@ enum PlayerDataType {
* @param page the page number * @param page the page number
* @param countries the countries to search * @param countries the countries to search
* @param withMetadata whether to include metadata * @param withMetadata whether to include metadata
* @returns the players * @returns {ScoresaberPlayerSearch} the players
*/ */
export async function getPlayers( export async function getPlayers(
search: string, search: string,
@ -45,7 +45,7 @@ export async function getPlayers(
/** /**
* Gets the number of active players on ScoreSaber * 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<number> { export async function getActivePlayerCount(): Promise<number> {
const url = `${CONSTS.BASE_URL}/${CONSTS.PLAYER_COUNT}`; const url = `${CONSTS.BASE_URL}/${CONSTS.PLAYER_COUNT}`;
@ -58,7 +58,7 @@ export async function getActivePlayerCount(): Promise<number> {
* *
* @param playerId the players id (not the name) * @param playerId the players id (not the name)
* @param type the type of data to get * @param type the type of data to get
* @returns the player data * @returns {ScoresaberPlayer} the player data
*/ */
export async function getPlayer( export async function getPlayer(
playerId: string, playerId: string,