@velliajs/discord 1.0.2 → 1.0.4

package/src/managers/GuildInviteManager.js

@@ -7,118 +7,34 @@ const { DiscordjsError, ErrorCodes } = require('../errors');
 const Invite = require('../structures/Invite');
 const DataResolver = require('../util/DataResolver');
 
-/**
- * Manages API methods for GuildInvites and stores their cache.
- * @extends {CachedManager}
- */
+
 class GuildInviteManager extends CachedManager {
   constructor(guild, iterable) {
     super(guild.client, Invite, iterable);
 
-    /**
-     * The guild this Manager belongs to
-     * @type {Guild}
-     */
+    
     this.guild = guild;
   }
 
-  /**
-   * The cache of this Manager
-   * @type {Collection<string, Invite>}
-   * @name GuildInviteManager#cache
-   */
+  
 
   _add(data, cache) {
     return super._add(data, cache, { id: data.code, extras: [this.guild] });
   }
 
-  /**
-   * Data that resolves to give an Invite object. This can be:
-   * * An invite code
-   * * An invite URL
-   * @typedef {string} InviteResolvable
-   */
-
-  /**
-   * Data that can be resolved to a channel that an invite can be created on. This can be:
-   * * TextChannel
-   * * VoiceChannel
-   * * NewsChannel
-   * * StageChannel
-   * * Snowflake
-   * @typedef {TextChannel|VoiceChannel|NewsChannel|StageChannel|Snowflake}
-   * GuildInvitableChannelResolvable
-   */
-
-  /**
-   * Resolves an InviteResolvable to an Invite object.
-   * @method resolve
-   * @memberof GuildInviteManager
-   * @instance
-   * @param {InviteResolvable} invite The invite resolvable to resolve
-   * @returns {?Invite}
-   */
-
-  /**
-   * Resolves an InviteResolvable to an invite code string.
-   * @method resolveId
-   * @memberof GuildInviteManager
-   * @instance
-   * @param {InviteResolvable} invite The invite resolvable to resolve
-   * @returns {?string}
-   */
-
-  /**
-   * Options used to fetch a single invite from a guild.
-   * @typedef {Object} FetchInviteOptions
-   * @property {InviteResolvable} code The invite to fetch
-   * @property {boolean} [cache=true] Whether or not to cache the fetched invite
-   * @property {boolean} [force=false] Whether to skip the cache check and request the API
-   */
-
-  /**
-   * Options used to fetch all invites from a guild.
-   * @typedef {Object} FetchInvitesOptions
-   * @property {GuildInvitableChannelResolvable} [channelId]
-   * The channel to fetch all invites from
-   * @property {boolean} [cache=true] Whether or not to cache the fetched invites
-   */
-
-  /**
-   * Fetches invite(s) from Discord.
-   * @param {InviteResolvable|FetchInviteOptions|FetchInvitesOptions} [options] Options for fetching guild invite(s)
-   * @returns {Promise<Invite|Collection<string, Invite>>}
-   * @example
-   * // Fetch all invites from a guild
-   * guild.invites.fetch()
-   *   .then(console.log)
-   *   .catch(console.error);
-   * @example
-   * // Fetch all invites from a guild without caching
-   * guild.invites.fetch({ cache: false })
-   *   .then(console.log)
-   *   .catch(console.error);
-   * @example
-   * // Fetch all invites from a channel
-   * guild.invites.fetch({ channelId: '222197033908436994' })
-   *   .then(console.log)
-   *   .catch(console.error);
-   * @example
-   * // Fetch a single invite
-   * guild.invites.fetch('bRCvFy9')
-   *   .then(console.log)
-   *   .catch(console.error);
-   * @example
-   * // Fetch a single invite without checking cache
-   * guild.invites.fetch({ code: 'bRCvFy9', force: true })
-   *   .then(console.log)
-   *   .catch(console.error)
-   * @example
-   * // Fetch a single invite without caching
-   * guild.invites.fetch({ code: 'bRCvFy9', cache: false })
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
+
+  
+
+  
+
+  
+
+  
+
+  
+
+  
   fetch(options) {
     if (!options) return this._fetchMany();
     if (typeof options === 'string') {
@@ -164,17 +80,7 @@ class GuildInviteManager extends CachedManager {
     return data.reduce((col, invite) => col.set(invite.code, this._add(invite, cache)), new Collection());
   }
 
-  /**
-   * Create an invite to the guild from the provided channel.
-   * @param {GuildInvitableChannelResolvable} channel The options for creating the invite from a channel.
-   * @param {InviteCreateOptions} [options={}] The options for creating the invite from a channel.
-   * @returns {Promise<Invite>}
-   * @example
-   * // Create an invite to a selected channel
-   * guild.invites.create('599942732013764608')
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
   async create(
     channel,
     { temporary, maxAge, maxUses, unique, targetUser, targetApplication, targetType, reason } = {},
@@ -197,12 +103,7 @@ class GuildInviteManager extends CachedManager {
     return new Invite(this.client, invite);
   }
 
-  /**
-   * Deletes an invite.
-   * @param {InviteResolvable} invite The invite to delete
-   * @param {string} [reason] Reason for deleting the invite
-   * @returns {Promise<void>}
-   */
+  
   async delete(invite, reason) {
     const code = DataResolver.resolveInviteCode(invite);
 

package/src/managers/GuildManager.js

@@ -21,10 +21,7 @@ const { resolveColor } = require('../util/Util');
 
 let cacheWarningEmitted = false;
 
-/**
- * Manages API methods for Guilds and stores their cache.
- * @extends {CachedManager}
- */
+
 class GuildManager extends CachedManager {
   constructor(client, iterable) {
     super(client, Guild, iterable);
@@ -37,72 +34,17 @@ class GuildManager extends CachedManager {
     }
   }
 
-  /**
-   * The cache of this Manager
-   * @type {Collection<Snowflake, Guild>}
-   * @name GuildManager#cache
-   */
+  
 
-  /**
-   * Data that resolves to give a Guild object. This can be:
-   * * A Guild object
-   * * A GuildChannel object
-   * * A GuildEmoji object
-   * * A Role object
-   * * A Snowflake
-   * * An Invite object
-   * @typedef {Guild|GuildChannel|GuildMember|GuildEmoji|Role|Snowflake|Invite} GuildResolvable
-   */
+  
 
-  /**
-   * Partial data for a Role.
-   * @typedef {Object} PartialRoleData
-   * @property {Snowflake|number} [id] The role's id, used to set channel overrides.
-   * This is a placeholder and will be replaced by the API after consumption
-   * @property {string} [name] The name of the role
-   * @property {ColorResolvable} [color] The color of the role, either a hex string or a base 10 number
-   * @property {boolean} [hoist] Whether the role should be hoisted
-   * @property {number} [position] The position of the role
-   * @property {PermissionResolvable} [permissions] The permissions of the role
-   * @property {boolean} [mentionable] Whether the role should be mentionable
-   */
+  
 
-  /**
-   * Partial overwrite data.
-   * @typedef {Object} PartialOverwriteData
-   * @property {Snowflake|number} id The id of the {@link Role} or {@link User} this overwrite belongs to
-   * @property {OverwriteType} [type] The type of this overwrite
-   * @property {PermissionResolvable} [allow] The permissions to allow
-   * @property {PermissionResolvable} [deny] The permissions to deny
-   */
+  
 
-  /**
-   * Partial data for a Channel.
-   * @typedef {Object} PartialChannelData
-   * @property {Snowflake|number} [id] The channel's id, used to set its parent.
-   * This is a placeholder and will be replaced by the API after consumption
-   * @property {Snowflake|number} [parentId] The parent id for this channel
-   * @property {ChannelType.GuildText|ChannelType.GuildVoice|ChannelType.GuildCategory} [type] The type of the channel
-   * @property {string} name The name of the channel
-   * @property {?string} [topic] The topic of the text channel
-   * @property {boolean} [nsfw] Whether the channel is NSFW
-   * @property {number} [bitrate] The bitrate of the voice channel
-   * @property {number} [userLimit] The user limit of the channel
-   * @property {?string} [rtcRegion] The RTC region of the channel
-   * @property {VideoQualityMode} [videoQualityMode] The camera video quality mode of the channel
-   * @property {PartialOverwriteData[]} [permissionOverwrites]
-   * Overwrites of the channel
-   * @property {number} [rateLimitPerUser] The rate limit per user (slowmode) of the channel in seconds
-   */
+  
 
-  /**
-   * Resolves a GuildResolvable to a Guild object.
-   * @method resolve
-   * @memberof GuildManager
-   * @instance
-   * @param {GuildResolvable} guild The guild resolvable to identify
-   * @returns {?Guild}
-   */
+  
   resolve(guild) {
     if (
       guild instanceof GuildChannel ||
@@ -116,14 +58,7 @@ class GuildManager extends CachedManager {
     return super.resolve(guild);
   }
 
-  /**
-   * Resolves a {@link GuildResolvable} to a {@link Guild} id string.
-   * @method resolveId
-   * @memberof GuildManager
-   * @instance
-   * @param {GuildResolvable} guild The guild resolvable to identify
-   * @returns {?Snowflake}
-   */
+  
   resolveId(guild) {
     if (
       guild instanceof GuildChannel ||
@@ -137,31 +72,10 @@ class GuildManager extends CachedManager {
     return super.resolveId(guild);
   }
 
-  /**
-   * Options used to create a guild.
-   * @typedef {Object} GuildCreateOptions
-   * @property {string} name The name of the guild
-   * @property {?(BufferResolvable|Base64Resolvable)} [icon=null] The icon for the guild
-   * @property {GuildVerificationLevel} [verificationLevel] The verification level for the guild
-   * @property {GuildDefaultMessageNotifications} [defaultMessageNotifications] The default message notifications
-   * for the guild
-   * @property {GuildExplicitContentFilter} [explicitContentFilter] The explicit content filter level for the guild
-   * @property {PartialRoleData[]} [roles=[]] The roles for this guild,
-   * @property {PartialChannelData[]} [channels=[]] The channels for this guild
-   * @property {Snowflake|number} [afkChannelId] The AFK channel's id
-   * @property {number} [afkTimeout] The AFK timeout in seconds
-   * the first element of this array is used to change properties of the guild's everyone role.
-   * @property {Snowflake|number} [systemChannelId] The system channel's id
-   * @property {SystemChannelFlagsResolvable} [systemChannelFlags] The flags of the system channel
-   */
-  /* eslint-enable max-len */
+  
+  
 
-  /**
-   * Creates a guild.
-   * <warn>This is only available to bots in fewer than 10 guilds.</warn>
-   * @param {GuildCreateOptions} options Options for creating the guild
-   * @returns {Promise<Guild>} The guild that was created
-   */
+  
   async create({
     name,
     icon = null,
@@ -240,26 +154,11 @@ class GuildManager extends CachedManager {
     );
   }
 
-  /**
-   * Options used to fetch a single guild.
-   * @typedef {BaseFetchOptions} FetchGuildOptions
-   * @property {GuildResolvable} guild The guild to fetch
-   * @property {boolean} [withCounts=true] Whether the approximate member and presence counts should be returned
-   */
+  
 
-  /**
-   * Options used to fetch multiple guilds.
-   * @typedef {Object} FetchGuildsOptions
-   * @property {Snowflake} [before] Get guilds before this guild id
-   * @property {Snowflake} [after] Get guilds after this guild id
-   * @property {number} [limit] Maximum number of guilds to request (1-200)
-   */
+  
 
-  /**
-   * Obtains one or multiple guilds from Discord, or the guild cache if it's already available.
-   * @param {GuildResolvable|FetchGuildOptions|FetchGuildsOptions} [options] The guild's id or options
-   * @returns {Promise<Guild|Collection<Snowflake, OAuth2Guild>>}
-   */
+  
   async fetch(options = {}) {
     const id = this.resolveId(options) ?? this.resolveId(options.guild);