From f8490da95334f95e032065b942b46935be49f240 Mon Sep 17 00:00:00 2001 From: starnakin Date: Thu, 25 Jan 2024 17:37:08 +0100 Subject: [PATCH] doc: fix: docstring: use Promise --- frontend/static/js/api/MyProfile.js | 2 +- frontend/static/js/api/account.js | 8 ++++---- frontend/static/js/api/client.js | 19 ++++++++++--------- frontend/static/js/api/matchmaking.js | 5 ++++- frontend/static/js/api/profile.js | 4 ++++ frontend/static/js/api/profiles.js | 6 +++--- .../static/js/api/tournament/tournament.js | 10 ++++++++++ .../static/js/api/tournament/tournaments.js | 7 ++++++- 8 files changed, 42 insertions(+), 19 deletions(-) diff --git a/frontend/static/js/api/MyProfile.js b/frontend/static/js/api/MyProfile.js index 208531a..de3f46e 100644 --- a/frontend/static/js/api/MyProfile.js +++ b/frontend/static/js/api/MyProfile.js @@ -15,7 +15,7 @@ class MyProfile extends Profile /** * * @param {*} form_data - * @returns + * @returns {Promise} */ async change_avatar(form_data) { diff --git a/frontend/static/js/api/account.js b/frontend/static/js/api/account.js index 6abb89b..b8b7e83 100644 --- a/frontend/static/js/api/account.js +++ b/frontend/static/js/api/account.js @@ -16,7 +16,7 @@ class Account /** * @param {String} username * @param {String} password - * @returns + * @returns {?Promise} */ async create(username, password) { @@ -33,7 +33,7 @@ class Account /** * @param {String} password - * @returns + * @returns {?Promise} */ async delete(password) { @@ -52,7 +52,7 @@ class Account /** * Get account data (username) - * @returns + * @returns {?Promise} */ async get() { @@ -71,7 +71,7 @@ class Account * * @param {*} data * @param {Number} password - * @returns + * @returns {?Object} */ async update(data, password) { diff --git a/frontend/static/js/api/client.js b/frontend/static/js/api/client.js index 57d3ce4..f514629 100644 --- a/frontend/static/js/api/client.js +++ b/frontend/static/js/api/client.js @@ -78,7 +78,7 @@ class Client /** * The only right way to determine is the user is logged - * @returns {Boolean} + * @returns {Promise} */ async isAuthentificate() { @@ -91,7 +91,7 @@ class Client * Send a GET request to %uri% * @param {String} uri * @param {*} data - * @returns {Response} + * @returns {Promise} */ async _get(uri, data) { @@ -106,7 +106,7 @@ class Client * Send a POST request * @param {String} uri * @param {*} data - * @returns {Response} + * @returns {Promise} */ async _post(uri, data) { @@ -125,7 +125,7 @@ class Client * Send a DELETE request * @param {String} uri * @param {String} data - * @returns {Response} + * @returns {Promise} */ async _delete(uri, data) { @@ -144,7 +144,7 @@ class Client * Send a PATCH request with json * @param {String} uri * @param {*} data - * @returns {Response} + * @returns {Promise} */ async _patch_json(uri, data) { @@ -163,7 +163,7 @@ class Client * Send a PATCH request with file * @param {String} uri * @param {*} file - * @returns {Response} + * @returns {Promise} */ async _patch_file(uri, file) { @@ -179,7 +179,7 @@ class Client /** * Change logged state. Use It if you recv an 403 error - * @param {Boolean} state + * @param {Promise} state * @returns */ async _update_logged(state) @@ -211,7 +211,7 @@ class Client * Loggin the user * @param {String} username * @param {String} password - * @returns + * @returns {Promise} */ async login(username, password) { @@ -224,6 +224,7 @@ class Client /** * Logout the user + * @returns {Promise} */ async logout() { @@ -233,7 +234,7 @@ class Client /** * Determine if the user is logged. NEVER USE IT, USE isAuthentificated() - * @returns {Boolean} + * @returns {Promise} */ async _test_logged() { diff --git a/frontend/static/js/api/matchmaking.js b/frontend/static/js/api/matchmaking.js index 1178803..c63dd4d 100644 --- a/frontend/static/js/api/matchmaking.js +++ b/frontend/static/js/api/matchmaking.js @@ -19,7 +19,7 @@ class MatchMaking * @param {CallableFunction} receive_func * @param {CallableFunction} disconnect_func * @param {Number} mode The number of players in a game - * @returns {undefined} + * @returns {Promise} */ async start(receive_func, disconnect_func, mode) { @@ -50,6 +50,9 @@ class MatchMaking this.disconnect_func(event); } + /** + * @returns {Promise} + */ async stop() { if (this._socket) diff --git a/frontend/static/js/api/profile.js b/frontend/static/js/api/profile.js index d15d0a4..2b57a04 100644 --- a/frontend/static/js/api/profile.js +++ b/frontend/static/js/api/profile.js @@ -34,6 +34,10 @@ class Profile this.isFriend = false; } + /** + * + * @returns {Promise<*>} + */ async init() { let response; diff --git a/frontend/static/js/api/profiles.js b/frontend/static/js/api/profiles.js index 070769c..7c0d924 100644 --- a/frontend/static/js/api/profiles.js +++ b/frontend/static/js/api/profiles.js @@ -15,7 +15,7 @@ class Profiles /** * - * @returns {[Profile]} + * @returns {Promise<[Profile]>} */ async all() { @@ -53,7 +53,7 @@ class Profiles /** * Block a user * @param {Number} user_id - * @returns + * @returns {Promise} */ async block(user_id) { @@ -70,7 +70,7 @@ class Profiles /** * Unblock a user * @param {Number} user_id - * @returns + * @returns {Promise} */ async deblock(user_id) { diff --git a/frontend/static/js/api/tournament/tournament.js b/frontend/static/js/api/tournament/tournament.js index b0ac785..46a9502 100644 --- a/frontend/static/js/api/tournament/tournament.js +++ b/frontend/static/js/api/tournament/tournament.js @@ -73,6 +73,10 @@ class Tourmanent this.connected = false; } + /** + * + * @returns {Promise} + */ async init() { let response = await this.client._get(`/api/tournaments/${id}`); @@ -108,6 +112,12 @@ class Tourmanent this._socket.send(JSON.stringify({participate: ""})); } + /** + * Join the tournament Websocket + * @param {CallableFunction} receive_func + * @param {CallableFunction} disconnect_func + * @returns {?} + */ async join(receive_func, disconnect_func) { if (!await this.client.isAuthentificate()) diff --git a/frontend/static/js/api/tournament/tournaments.js b/frontend/static/js/api/tournament/tournaments.js index 2ae420a..9f00564 100644 --- a/frontend/static/js/api/tournament/tournaments.js +++ b/frontend/static/js/api/tournament/tournaments.js @@ -17,7 +17,7 @@ class Tourmanents /** * * @param {Number} id - * @returns + * @returns {?Promise} */ async getTournament(id) { @@ -47,6 +47,7 @@ class Tourmanents /** * @param {String} state must be "finished", or "started", or "waiting". Any other return all elements + * @returns {?Promise<[Tourmanent]>} */ async search(state) { @@ -76,6 +77,10 @@ class Tourmanents return tournaments; } + /** + * Get all tournaments + * @returns {?Promise<[Tourmanent]>} + */ async all() { return await this.search("");