docs: general cleanup and improvements (#6299)

Co-authored-by: DaStormer <40336269+DaStormer@users.noreply.github.com>
Co-authored-by: Sugden <28943913+NotSugden@users.noreply.github.com>
Co-authored-by: SpaceEEC <spaceeec@yahoo.com>
This commit is contained in:
Rodry
2021-08-05 20:34:06 +01:00
committed by GitHub
parent 4241febe24
commit b4afcf8236
39 changed files with 203 additions and 136 deletions

View File

@@ -41,11 +41,16 @@ class ClientUser extends User {
return this.client.presence;
}
/**
* Data used to edit the logged in client
* @typdef {Object} ClientUserEditData
* @property {string} [username] The new username
* @property {BufferResolvable|Base64Resolvable} [avatar] The new avatar
*/
/**
* Edits the logged in client.
* @param {APIModifyClientData} data The new data
* @param {string} [data.username] The new username
* @param {BufferResolvable|Base64Resolvable} [data.avatar] The new avatar
* @param {ClientUserEditData} data The new data
*/
async edit(data) {
const newData = await this.client.api.users('@me').patch({ data });
@@ -172,8 +177,3 @@ class ClientUser extends User {
}
module.exports = ClientUser;
/**
* @external APIModifyClientData
* @see {@link https://discord.com/developers/docs/resources/user#modify-current-user-json-params}
*/