Skip to content

Commit

Permalink
Add typedef for GuildmemberEditData. (#1230)
Browse files Browse the repository at this point in the history
* Add typedef for GuildmemberEditData.

* Farm commits

* Make terms consistent.
  • Loading branch information
hkwu authored and Gawdl3y committed Mar 1, 2017
1 parent b6f74c4 commit 01d8d32
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion src/structures/GuildMember.js
Expand Up @@ -284,9 +284,19 @@ class GuildMember {
return permissions.filter(p => !this.hasPermission(p, explicit));
}

/**
* The data for editing a guild member
* @typedef {Object} GuildMemberEditData
* @property {string} [nick] The nickname to set for the member
* @property {Collection<Snowflake, Role>|Role[]|Snowflake[]} [roles] The roles or role IDs to apply
* @property {boolean} [mute] Whether or not the member should be muted
* @property {boolean} [deaf] Whether or not the member should be deafened
* @property {ChannelResolvable} [channel] Channel to move member to (if they are connected to voice)
*/

/**
* Edit a guild member
* @param {GuildmemberEditData} data The data to edit the member with
* @param {GuildMemberEditData} data The data to edit the member with
* @returns {Promise<GuildMember>}
*/
edit(data) {
Expand Down

0 comments on commit 01d8d32

Please sign in to comment.