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

@ -13,6 +13,10 @@ class Profiles
this.client = client
}
/**
*
* @returns {[Profile]}
*/
async all()
{
let response = await this.client._get("/api/profiles/");
@ -25,6 +29,11 @@ class Profiles
return profiles;
}
/**
*
* @param {String} username
* @returns {?Profile}
*/
async getProfile(username)
{
let profile = new Profile(this.client, username);
@ -33,6 +42,11 @@ class Profiles
return profile;
}
/**
* Block a user
* @param {Number} user_id
* @returns
*/
async block(user_id) {
// blocker & blocked
@ -45,6 +59,11 @@ class Profiles
}
/**
* Unblock a user
* @param {Number} user_id
* @returns
*/
async deblock(user_id) {
// blocker & blocked