doc: fix: docstring: use Promise
This commit is contained in:
parent
8eeb9ed4ab
commit
c23500e0a0
@ -15,7 +15,7 @@ class MyProfile extends Profile
|
||||
/**
|
||||
*
|
||||
* @param {*} form_data
|
||||
* @returns
|
||||
* @returns {Promise<Object>}
|
||||
*/
|
||||
async change_avatar(form_data)
|
||||
{
|
||||
|
@ -16,7 +16,7 @@ class Account
|
||||
/**
|
||||
* @param {String} username
|
||||
* @param {String} password
|
||||
* @returns
|
||||
* @returns {?Promise<Object>}
|
||||
*/
|
||||
async create(username, password)
|
||||
{
|
||||
@ -33,7 +33,7 @@ class Account
|
||||
|
||||
/**
|
||||
* @param {String} password
|
||||
* @returns
|
||||
* @returns {?Promise<Object>}
|
||||
*/
|
||||
async delete(password)
|
||||
{
|
||||
@ -52,7 +52,7 @@ class Account
|
||||
|
||||
/**
|
||||
* Get account data (username)
|
||||
* @returns
|
||||
* @returns {?Promise<Object>}
|
||||
*/
|
||||
async get()
|
||||
{
|
||||
@ -71,7 +71,7 @@ class Account
|
||||
*
|
||||
* @param {*} data
|
||||
* @param {Number} password
|
||||
* @returns
|
||||
* @returns {?Object}
|
||||
*/
|
||||
async update(data, password)
|
||||
{
|
||||
|
@ -77,7 +77,7 @@ class Client
|
||||
|
||||
/**
|
||||
* The only right way to determine is the user is logged
|
||||
* @returns {Boolean}
|
||||
* @returns {Promise<Boolean>}
|
||||
*/
|
||||
async isAuthentificate()
|
||||
{
|
||||
@ -90,7 +90,7 @@ class Client
|
||||
* Send a GET request to %uri%
|
||||
* @param {String} uri
|
||||
* @param {*} data
|
||||
* @returns {Response}
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
async _get(uri, data)
|
||||
{
|
||||
@ -105,7 +105,7 @@ class Client
|
||||
* Send a POST request
|
||||
* @param {String} uri
|
||||
* @param {*} data
|
||||
* @returns {Response}
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
async _post(uri, data)
|
||||
{
|
||||
@ -124,7 +124,7 @@ class Client
|
||||
* Send a DELETE request
|
||||
* @param {String} uri
|
||||
* @param {String} data
|
||||
* @returns {Response}
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
async _delete(uri, data)
|
||||
{
|
||||
@ -143,7 +143,7 @@ class Client
|
||||
* Send a PATCH request with json
|
||||
* @param {String} uri
|
||||
* @param {*} data
|
||||
* @returns {Response}
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
async _patch_json(uri, data)
|
||||
{
|
||||
@ -162,7 +162,7 @@ class Client
|
||||
* Send a PATCH request with file
|
||||
* @param {String} uri
|
||||
* @param {*} file
|
||||
* @returns {Response}
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
async _patch_file(uri, file)
|
||||
{
|
||||
@ -178,7 +178,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)
|
||||
@ -210,7 +210,7 @@ class Client
|
||||
* Loggin the user
|
||||
* @param {String} username
|
||||
* @param {String} password
|
||||
* @returns
|
||||
* @returns {Promise<Response>}
|
||||
*/
|
||||
async login(username, password)
|
||||
{
|
||||
@ -223,6 +223,7 @@ class Client
|
||||
|
||||
/**
|
||||
* Logout the user
|
||||
* @returns {Promise<?>}
|
||||
*/
|
||||
async logout()
|
||||
{
|
||||
@ -232,7 +233,7 @@ class Client
|
||||
|
||||
/**
|
||||
* Determine if the user is logged. NEVER USE IT, USE isAuthentificated()
|
||||
* @returns {Boolean}
|
||||
* @returns {Promise<Boolean>}
|
||||
*/
|
||||
async _test_logged()
|
||||
{
|
||||
|
@ -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)
|
||||
|
@ -33,6 +33,10 @@ class Profile
|
||||
this.isBlocked = false;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @returns {Promise<*>}
|
||||
*/
|
||||
async init()
|
||||
{
|
||||
let response = await this.client._get(`/api/profiles/${this.username}`);
|
||||
|
@ -15,7 +15,7 @@ class Profiles
|
||||
|
||||
/**
|
||||
*
|
||||
* @returns {[Profile]}
|
||||
* @returns {Promise<[Profile]>}
|
||||
*/
|
||||
async all()
|
||||
{
|
||||
@ -45,7 +45,7 @@ class Profiles
|
||||
/**
|
||||
* Block a user
|
||||
* @param {Number} user_id
|
||||
* @returns
|
||||
* @returns {Promise<Object>}
|
||||
*/
|
||||
async block(user_id) {
|
||||
|
||||
@ -62,7 +62,7 @@ class Profiles
|
||||
/**
|
||||
* Unblock a user
|
||||
* @param {Number} user_id
|
||||
* @returns
|
||||
* @returns {Promise<Object>}
|
||||
*/
|
||||
async deblock(user_id) {
|
||||
|
||||
|
@ -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())
|
||||
|
@ -17,7 +17,7 @@ class Tourmanents
|
||||
/**
|
||||
*
|
||||
* @param {Number} id
|
||||
* @returns
|
||||
* @returns {?Promise<Tournament>}
|
||||
*/
|
||||
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("");
|
||||
|
Loading…
Reference in New Issue
Block a user