game: add: docstring

This commit is contained in:
2024-01-22 13:21:51 +01:00
parent ab73826c11
commit 6fd11d0028
10 changed files with 231 additions and 12 deletions

View File

@ -14,6 +14,11 @@ class Tourmanents
this.client = client
}
/**
*
* @param {Number} id
* @returns
*/
async getTournament(id)
{
let tournament = new Tourmanent(this.client);
@ -22,6 +27,13 @@ class Tourmanents
return tournament;
}
/**
*
* @param {Number} nb_players
* @param {Number} nb_players_by_game
* @param {String} name
* @returns
*/
async createTournament(nb_players, nb_players_by_game, name = "")
{
let response = await this.client._post("/api/tournaments/", {nb_players: nb_players, nb_players_by_game: nb_players_by_game, name: name});
@ -34,15 +46,14 @@ class Tourmanents
}
/**
* @param {string} state must be "finished", or "started", or "waiting". Any other return all elements
* @param {String} state must be "finished", or "started", or "waiting". Any other return all elements
*/
async search(state)
{
let response = await this.client._get(`/api/tournaments/search/${state}`);
let response_data = await response.json()
if (response.status === 404)
if (response.status === 403)
{
this.client._update_logged(false);
return null;