doc: fix: docstring: use Promise

This commit is contained in:
starnakin 2024-01-25 17:37:08 +01:00 committed by AdrienLSH
parent 22dd4a0299
commit f8490da953
8 changed files with 42 additions and 19 deletions

View File

@ -15,7 +15,7 @@ class MyProfile extends Profile
/** /**
* *
* @param {*} form_data * @param {*} form_data
* @returns * @returns {Promise<Object>}
*/ */
async change_avatar(form_data) async change_avatar(form_data)
{ {

View File

@ -16,7 +16,7 @@ class Account
/** /**
* @param {String} username * @param {String} username
* @param {String} password * @param {String} password
* @returns * @returns {?Promise<Object>}
*/ */
async create(username, password) async create(username, password)
{ {
@ -33,7 +33,7 @@ class Account
/** /**
* @param {String} password * @param {String} password
* @returns * @returns {?Promise<Object>}
*/ */
async delete(password) async delete(password)
{ {
@ -52,7 +52,7 @@ class Account
/** /**
* Get account data (username) * Get account data (username)
* @returns * @returns {?Promise<Object>}
*/ */
async get() async get()
{ {
@ -71,7 +71,7 @@ class Account
* *
* @param {*} data * @param {*} data
* @param {Number} password * @param {Number} password
* @returns * @returns {?Object}
*/ */
async update(data, password) async update(data, password)
{ {

View File

@ -78,7 +78,7 @@ class Client
/** /**
* The only right way to determine is the user is logged * The only right way to determine is the user is logged
* @returns {Boolean} * @returns {Promise<Boolean>}
*/ */
async isAuthentificate() async isAuthentificate()
{ {
@ -91,7 +91,7 @@ class Client
* Send a GET request to %uri% * Send a GET request to %uri%
* @param {String} uri * @param {String} uri
* @param {*} data * @param {*} data
* @returns {Response} * @returns {Promise<Response>}
*/ */
async _get(uri, data) async _get(uri, data)
{ {
@ -106,7 +106,7 @@ class Client
* Send a POST request * Send a POST request
* @param {String} uri * @param {String} uri
* @param {*} data * @param {*} data
* @returns {Response} * @returns {Promise<Response>}
*/ */
async _post(uri, data) async _post(uri, data)
{ {
@ -125,7 +125,7 @@ class Client
* Send a DELETE request * Send a DELETE request
* @param {String} uri * @param {String} uri
* @param {String} data * @param {String} data
* @returns {Response} * @returns {Promise<Response>}
*/ */
async _delete(uri, data) async _delete(uri, data)
{ {
@ -144,7 +144,7 @@ class Client
* Send a PATCH request with json * Send a PATCH request with json
* @param {String} uri * @param {String} uri
* @param {*} data * @param {*} data
* @returns {Response} * @returns {Promise<Response>}
*/ */
async _patch_json(uri, data) async _patch_json(uri, data)
{ {
@ -163,7 +163,7 @@ class Client
* Send a PATCH request with file * Send a PATCH request with file
* @param {String} uri * @param {String} uri
* @param {*} file * @param {*} file
* @returns {Response} * @returns {Promise<Response>}
*/ */
async _patch_file(uri, file) async _patch_file(uri, file)
{ {
@ -179,7 +179,7 @@ class Client
/** /**
* Change logged state. Use It if you recv an 403 error * Change logged state. Use It if you recv an 403 error
* @param {Boolean} state * @param {Promise<?>} state
* @returns * @returns
*/ */
async _update_logged(state) async _update_logged(state)
@ -211,7 +211,7 @@ class Client
* Loggin the user * Loggin the user
* @param {String} username * @param {String} username
* @param {String} password * @param {String} password
* @returns * @returns {Promise<Response>}
*/ */
async login(username, password) async login(username, password)
{ {
@ -224,6 +224,7 @@ class Client
/** /**
* Logout the user * Logout the user
* @returns {Promise<?>}
*/ */
async logout() async logout()
{ {
@ -233,7 +234,7 @@ class Client
/** /**
* Determine if the user is logged. NEVER USE IT, USE isAuthentificated() * Determine if the user is logged. NEVER USE IT, USE isAuthentificated()
* @returns {Boolean} * @returns {Promise<Boolean>}
*/ */
async _test_logged() async _test_logged()
{ {

View File

@ -19,7 +19,7 @@ class MatchMaking
* @param {CallableFunction} receive_func * @param {CallableFunction} receive_func
* @param {CallableFunction} disconnect_func * @param {CallableFunction} disconnect_func
* @param {Number} mode The number of players in a game * @param {Number} mode The number of players in a game
* @returns {undefined} * @returns {Promise<?>}
*/ */
async start(receive_func, disconnect_func, mode) async start(receive_func, disconnect_func, mode)
{ {
@ -50,6 +50,9 @@ class MatchMaking
this.disconnect_func(event); this.disconnect_func(event);
} }
/**
* @returns {Promise<?>}
*/
async stop() async stop()
{ {
if (this._socket) if (this._socket)

View File

@ -34,6 +34,10 @@ class Profile
this.isFriend = false; this.isFriend = false;
} }
/**
*
* @returns {Promise<*>}
*/
async init() async init()
{ {
let response; let response;

View File

@ -15,7 +15,7 @@ class Profiles
/** /**
* *
* @returns {[Profile]} * @returns {Promise<[Profile]>}
*/ */
async all() async all()
{ {
@ -53,7 +53,7 @@ class Profiles
/** /**
* Block a user * Block a user
* @param {Number} user_id * @param {Number} user_id
* @returns * @returns {Promise<Object>}
*/ */
async block(user_id) { async block(user_id) {
@ -70,7 +70,7 @@ class Profiles
/** /**
* Unblock a user * Unblock a user
* @param {Number} user_id * @param {Number} user_id
* @returns * @returns {Promise<Object>}
*/ */
async deblock(user_id) { async deblock(user_id) {

View File

@ -73,6 +73,10 @@ class Tourmanent
this.connected = false; this.connected = false;
} }
/**
*
* @returns {Promise<?>}
*/
async init() async init()
{ {
let response = await this.client._get(`/api/tournaments/${id}`); let response = await this.client._get(`/api/tournaments/${id}`);
@ -108,6 +112,12 @@ class Tourmanent
this._socket.send(JSON.stringify({participate: ""})); 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) async join(receive_func, disconnect_func)
{ {
if (!await this.client.isAuthentificate()) if (!await this.client.isAuthentificate())

View File

@ -17,7 +17,7 @@ class Tourmanents
/** /**
* *
* @param {Number} id * @param {Number} id
* @returns * @returns {?Promise<Tournament>}
*/ */
async getTournament(id) async getTournament(id)
{ {
@ -47,6 +47,7 @@ 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
* @returns {?Promise<[Tourmanent]>}
*/ */
async search(state) async search(state)
{ {
@ -76,6 +77,10 @@ class Tourmanents
return tournaments; return tournaments;
} }
/**
* Get all tournaments
* @returns {?Promise<[Tourmanent]>}
*/
async all() async all()
{ {
return await this.search(""); return await this.search("");