From 7473fd513eb6f092495b04adb82f6cf01054bf9e Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Wed, 1 Mar 2017 04:48:26 -0500 Subject: [PATCH] Remove InviteOptions typedef, rephrase --- src/structures/GuildChannel.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/structures/GuildChannel.js b/src/structures/GuildChannel.js index 77b634f34..9b8a5fbc4 100644 --- a/src/structures/GuildChannel.js +++ b/src/structures/GuildChannel.js @@ -234,14 +234,16 @@ class GuildChannel extends Channel { /** * Options given when creating a guild channel invite * @typedef {Object} InviteOptions - * @property {boolean} [temporary=false] Whether the invite should kick users after 24hrs if they are not given a role - * @property {number} [maxAge=86400] How long the invite shoud last (in seconds, 0 for forever) - * @property {number} [maxUses=0] Maximum amount of uses for this invite + */ /** * Create an invite to this guild channel - * @param {InviteOptions} [options={}] The options for the invite + * @param {InviteOptions} [options={}] Options for the invite + * @param {boolean} [options.temporary=false] Whether members that joined via the invite should be automatically + * kicked after 24 hours if they have not yet received a role + * @param {number} [options.maxAge=86400] How long the invite should last (in seconds, 0 for forever) + * @param {number} [options.maxUses=0] Maximum number of uses * @returns {Promise} */ createInvite(options = {}) {