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

Remove InviteOptions typedef, rephrase

Browse Source
This commit is contained in:
Schuyler Cebulskie
2017-03-01 04:48:26 -05:00
parent fc42a46e5b
commit 7473fd513e
1 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/structures/GuildChannel.js
View File

@@ -234,14 +234,16 @@ class GuildChannel extends Channel {
/** /**
* Options given when creating a guild channel invite * Options given when creating a guild channel invite
* @typedef {Object} InviteOptions * @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 * 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<Invite>} * @returns {Promise<Invite>}
*/ */
createInvite(options = {}) { createInvite(options = {}) {