Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-16 03:23:29 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add typedef for GuildmemberEditData. (#1230)

Browse Source 
* Add typedef for GuildmemberEditData.

* Farm commits

* Make terms consistent.
This commit is contained in:
Kelvin Wu
2017-03-01 04:36:17 -05:00
committed by Schuyler Cebulskie
parent b6f74c45fe
commit 01d8d32ea9
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/structures/GuildMember.js
View File

@@ -284,9 +284,19 @@ class GuildMember {
return permissions.filter(p => !this.hasPermission(p, explicit)); 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 * 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>} * @returns {Promise<GuildMember>}
*/ */
edit(data) { edit(data) {