From 01d8d32ea936f37821cef7bad623770d87f1b540 Mon Sep 17 00:00:00 2001 From: Kelvin Wu Date: Wed, 1 Mar 2017 04:36:17 -0500 Subject: [PATCH] Add typedef for GuildmemberEditData. (#1230) * Add typedef for GuildmemberEditData. * Farm commits * Make terms consistent. --- src/structures/GuildMember.js | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/structures/GuildMember.js b/src/structures/GuildMember.js index bcf42d87c..425873c05 100644 --- a/src/structures/GuildMember.js +++ b/src/structures/GuildMember.js @@ -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|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} */ edit(data) {