@velliajs/discord 1.0.3 → 1.0.4

package/src/structures/GuildChannel.js

@@ -7,36 +7,17 @@ const PermissionOverwriteManager = require('../managers/PermissionOverwriteManag
 const { VoiceBasedChannelTypes } = require('../util/Constants');
 const PermissionsBitField = require('../util/PermissionsBitField');
 
-/**
- * Represents a guild channel from any of the following:
- * - {@link TextChannel}
- * - {@link VoiceChannel}
- * - {@link CategoryChannel}
- * - {@link NewsChannel}
- * - {@link StageChannel}
- * - {@link ForumChannel}
- * @extends {BaseChannel}
- * @abstract
- */
+
 class GuildChannel extends BaseChannel {
   constructor(guild, data, client, immediatePatch = true) {
     super(client, data, false);
 
-    /**
-     * The guild the channel is in
-     * @type {Guild}
-     */
+    
     this.guild = guild;
 
-    /**
-     * The id of the guild the channel is in
-     * @type {Snowflake}
-     */
+    
     this.guildId = guild?.id ?? data.guild_id;
-    /**
-     * A manager of permission overwrites that belong to this channel
-     * @type {PermissionOverwriteManager}
-     */
+    
     this.permissionOverwrites = new PermissionOverwriteManager(this);
 
     if (data && immediatePatch) this._patch(data);
@@ -46,18 +27,12 @@ class GuildChannel extends BaseChannel {
     super._patch(data);
 
     if ('name' in data) {
-      /**
-       * The name of the guild channel
-       * @type {string}
-       */
+      
       this.name = data.name;
     }
 
     if ('position' in data) {
-      /**
-       * The raw position of the channel from Discord
-       * @type {number}
-       */
+      
       this.rawPosition = data.position;
     }
 
@@ -66,10 +41,7 @@ class GuildChannel extends BaseChannel {
     }
 
     if ('parent_id' in data) {
-      /**
-       * The id of the category parent of this channel
-       * @type {?Snowflake}
-       */
+      
       this.parentId = data.parent_id;
     } else {
       this.parentId ??= null;
@@ -89,35 +61,27 @@ class GuildChannel extends BaseChannel {
     return clone;
   }
 
-  /**
-   * The category parent of this channel
-   * @type {?CategoryChannel}
-   * @readonly
-   */
+  
   get parent() {
     return this.guild.channels.resolve(this.parentId);
   }
 
-  /**
-   * If the permissionOverwrites match the parent channel, null if no parent
-   * @type {?boolean}
-   * @readonly
-   */
+  
   get permissionsLocked() {
     if (!this.parent) return null;
 
-    // Get all overwrites
+    
     const overwriteIds = new Set([
       ...this.permissionOverwrites.cache.keys(),
       ...this.parent.permissionOverwrites.cache.keys(),
     ]);
 
-    // Compare all overwrites
+    
     return [...overwriteIds].every(key => {
       const channelVal = this.permissionOverwrites.cache.get(key);
       const parentVal = this.parent.permissionOverwrites.cache.get(key);
 
-      // Handle empty overwrite
+      
       if (
         (!channelVal &&
           parentVal.deny.bitfield === PermissionsBitField.DefaultBit &&
@@ -129,7 +93,7 @@ class GuildChannel extends BaseChannel {
         return true;
       }
 
-      // Compare overwrites
+      
       return (
         channelVal !== undefined &&
         parentVal !== undefined &&
@@ -139,23 +103,13 @@ class GuildChannel extends BaseChannel {
     });
   }
 
-  /**
-   * The position of the channel
-   * @type {number}
-   * @readonly
-   */
+  
   get position() {
     const sorted = this.guild._sortedChannels(this);
     return [...sorted.values()].indexOf(sorted.get(this.id));
   }
 
-  /**
-   * Gets the overall set of permissions for a member or role in this channel, taking into account channel overwrites.
-   * @param {GuildMemberResolvable|RoleResolvable} memberOrRole The member or role to obtain the overall permissions for
-   * @param {boolean} [checkAdmin=true] Whether having the {@link PermissionFlagsBits.Administrator} permission
-   * will return all permissions
-   * @returns {?Readonly<PermissionsBitField>}
-   */
+  
   permissionsFor(memberOrRole, checkAdmin = true) {
     const member = this.guild.members.resolve(memberOrRole);
     if (member) return this.memberPermissions(member, checkAdmin);
@@ -189,14 +143,7 @@ class GuildChannel extends BaseChannel {
     };
   }
 
-  /**
-   * Gets the overall set of permissions for a member in this channel, taking into account channel overwrites.
-   * @param {GuildMember} member The member to obtain the overall permissions for
-   * @param {boolean} checkAdmin Whether having the {@link PermissionFlagsBits.Administrator} permission
-   * will return all permissions
-   * @returns {Readonly<PermissionsBitField>}
-   * @private
-   */
+  
   memberPermissions(member, checkAdmin) {
     if (checkAdmin && member.id === this.guild.ownerId) {
       return new PermissionsBitField(PermissionsBitField.All).freeze();
@@ -221,14 +168,7 @@ class GuildChannel extends BaseChannel {
       .freeze();
   }
 
-  /**
-   * Gets the overall set of permissions for a role in this channel, taking into account channel overwrites.
-   * @param {Role} role The role to obtain the overall permissions for
-   * @param {boolean} checkAdmin Whether having the {@link PermissionFlagsBits.Administrator} permission
-   * will return all permissions
-   * @returns {Readonly<PermissionsBitField>}
-   * @private
-   */
+  
   rolePermissions(role, checkAdmin) {
     if (checkAdmin && role.permissions.has(PermissionFlagsBits.Administrator)) {
       return new PermissionsBitField(PermissionsBitField.All).freeze();
@@ -245,74 +185,31 @@ class GuildChannel extends BaseChannel {
       .freeze();
   }
 
-  /**
-   * Locks in the permission overwrites from the parent channel.
-   * @returns {Promise<GuildChannel>}
-   */
+  
   lockPermissions() {
     if (!this.parent) return Promise.reject(new DiscordjsError(ErrorCodes.GuildChannelOrphan));
     const permissionOverwrites = this.parent.permissionOverwrites.cache.map(overwrite => overwrite.toJSON());
     return this.edit({ permissionOverwrites });
   }
 
-  /**
-   * A collection of cached members of this channel, mapped by their ids.
-   * Members that can view this channel, if the channel is text-based.
-   * Members in the channel, if the channel is voice-based.
-   * @type {Collection<Snowflake, GuildMember>}
-   * @readonly
-   */
+  
   get members() {
     return this.guild.members.cache.filter(m => this.permissionsFor(m).has(PermissionFlagsBits.ViewChannel, false));
   }
 
-  /**
-   * Edits the channel.
-   * @param {GuildChannelEditOptions} options The options to provide
-   * @returns {Promise<GuildChannel>}
-   * @example
-   * // Edit a channel
-   * channel.edit({ name: 'new-channel' })
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
   edit(options) {
     return this.guild.channels.edit(this, options);
   }
 
-  /**
-   * Sets a new name for the guild channel.
-   * @param {string} name The new name for the guild channel
-   * @param {string} [reason] Reason for changing the guild channel's name
-   * @returns {Promise<GuildChannel>}
-   * @example
-   * // Set a new channel name
-   * channel.setName('not_general')
-   *   .then(newChannel => console.log(`Channel's new name is ${newChannel.name}`))
-   *   .catch(console.error);
-   */
+  
   setName(name, reason) {
     return this.edit({ name, reason });
   }
 
-  /**
-   * Options used to set the parent of a channel.
-   * @typedef {Object} SetParentOptions
-   * @property {boolean} [lockPermissions=true] Whether to lock the permissions to what the parent's permissions are
-   * @property {string} [reason] The reason for modifying the parent of the channel
-   */
-
-  /**
-   * Sets the parent of this channel.
-   * @param {?CategoryChannelResolvable} channel The category channel to set as the parent
-   * @param {SetParentOptions} [options={}] The options for setting the parent
-   * @returns {Promise<GuildChannel>}
-   * @example
-   * // Add a parent to a channel
-   * message.channel.setParent('355908108431917066', { lockPermissions: false })
-   *   .then(channel => console.log(`New parent of ${message.channel.name}: ${channel.name}`))
-   *   .catch(console.error);
-   */
+  
+
+  
   setParent(channel, { lockPermissions = true, reason } = {}) {
     return this.edit({
       parent: channel ?? null,
@@ -321,39 +218,16 @@ class GuildChannel extends BaseChannel {
     });
   }
 
-  /**
-   * Options used to set the position of a channel.
-   * @typedef {Object} SetChannelPositionOptions
-   * @property {boolean} [relative=false] Whether or not to change the position relative to its current value
-   * @property {string} [reason] The reason for changing the position
-   */
-
-  /**
-   * Sets a new position for the guild channel.
-   * @param {number} position The new position for the guild channel
-   * @param {SetChannelPositionOptions} [options] Options for setting position
-   * @returns {Promise<GuildChannel>}
-   * @example
-   * // Set a new channel position
-   * channel.setPosition(2)
-   *   .then(newChannel => console.log(`Channel's new position is ${newChannel.position}`))
-   *   .catch(console.error);
-   */
+  
+
+  
   setPosition(position, options = {}) {
     return this.guild.channels.setPosition(this, position, options);
   }
 
-  /**
-   * Options used to clone a guild channel.
-   * @typedef {GuildChannelCreateOptions} GuildChannelCloneOptions
-   * @property {string} [name=this.name] Name of the new channel
-   */
-
-  /**
-   * Clones this channel.
-   * @param {GuildChannelCloneOptions} [options] The options for cloning this channel
-   * @returns {Promise<GuildChannel>}
-   */
+  
+
+  
   clone(options = {}) {
     return this.guild.channels.create({
       name: options.name ?? this.name,
@@ -371,12 +245,7 @@ class GuildChannel extends BaseChannel {
     });
   }
 
-  /**
-   * Checks if this channel has the same type, topic, position, name, overwrites, and id as another channel.
-   * In most cases, a simple `channel.id === channel2.id` will do, and is much faster too.
-   * @param {GuildChannel} channel Channel to compare with
-   * @returns {boolean}
-   */
+  
   equals(channel) {
     let equal =
       channel &&
@@ -397,26 +266,18 @@ class GuildChannel extends BaseChannel {
     return equal;
   }
 
-  /**
-   * Whether the channel is deletable by the client user
-   * @type {boolean}
-   * @readonly
-   */
+  
   get deletable() {
     return this.manageable && this.guild.rulesChannelId !== this.id && this.guild.publicUpdatesChannelId !== this.id;
   }
 
-  /**
-   * Whether the channel is manageable by the client user
-   * @type {boolean}
-   * @readonly
-   */
+  
   get manageable() {
     if (this.client.user.id === this.guild.ownerId) return true;
     const permissions = this.permissionsFor(this.client.user);
     if (!permissions) return false;
 
-    // This flag allows managing even if timed out
+    
     if (permissions.has(PermissionFlagsBits.Administrator, false)) return true;
     if (this.guild.members.me.communicationDisabledUntilTimestamp > Date.now()) return false;
 
@@ -426,11 +287,7 @@ class GuildChannel extends BaseChannel {
     return permissions.has(bitfield, false);
   }
 
-  /**
-   * Whether the channel is viewable by the client user
-   * @type {boolean}
-   * @readonly
-   */
+  
   get viewable() {
     if (this.client.user.id === this.guild.ownerId) return true;
     const permissions = this.permissionsFor(this.client.user);
@@ -438,16 +295,7 @@ class GuildChannel extends BaseChannel {
     return permissions.has(PermissionFlagsBits.ViewChannel, false);
   }
 
-  /**
-   * Deletes this channel.
-   * @param {string} [reason] Reason for deleting this channel
-   * @returns {Promise<GuildChannel>}
-   * @example
-   * // Delete the channel
-   * channel.delete('making room for new channels')
-   *   .then(console.log)
-   *   .catch(console.error);
-   */
+  
   async delete(reason) {
     await this.guild.channels.delete(this.id, reason);
     return this;

package/src/structures/GuildEmoji.js

@@ -5,36 +5,21 @@ const BaseGuildEmoji = require('./BaseGuildEmoji');
 const { DiscordjsError, ErrorCodes } = require('../errors');
 const GuildEmojiRoleManager = require('../managers/GuildEmojiRoleManager');
 
-/**
- * Represents a custom emoji.
- * @extends {BaseGuildEmoji}
- */
+
 class GuildEmoji extends BaseGuildEmoji {
   constructor(client, data, guild) {
     super(client, data, guild);
 
-    /**
-     * The user who created this emoji
-     * @type {?User}
-     */
+    
     this.author = null;
 
-    /**
-     * Array of role ids this emoji is active for
-     * @name GuildEmoji#_roles
-     * @type {Snowflake[]}
-     * @private
-     */
+    
     Object.defineProperty(this, '_roles', { value: [], writable: true });
 
     this._patch(data);
   }
 
-  /**
-   * The guild this emoji is part of
-   * @type {Guild}
-   * @name GuildEmoji#guild
-   */
+  
 
   _clone() {
     const clone = super._clone();
@@ -49,80 +34,41 @@ class GuildEmoji extends BaseGuildEmoji {
     if (data.roles) this._roles = data.roles;
   }
 
-  /**
-   * Whether the emoji is deletable by the client user
-   * @type {boolean}
-   * @readonly
-   */
+  
   get deletable() {
     if (!this.guild.members.me) throw new DiscordjsError(ErrorCodes.GuildUncachedMe);
     return !this.managed && this.guild.members.me.permissions.has(PermissionFlagsBits.ManageGuildExpressions);
   }
 
-  /**
-   * A manager for roles this emoji is active for.
-   * @type {GuildEmojiRoleManager}
-   * @readonly
-   */
+  
   get roles() {
     return new GuildEmojiRoleManager(this);
   }
 
-  /**
-   * Fetches the author for this emoji
-   * @returns {Promise<User>}
-   */
+  
   fetchAuthor() {
     return this.guild.emojis.fetchAuthor(this);
   }
 
-  /**
-   * Data for editing an emoji.
-   * @typedef {Object} GuildEmojiEditOptions
-   * @property {string} [name] The name of the emoji
-   * @property {Collection<Snowflake, Role>|RoleResolvable[]} [roles] Roles to restrict emoji to
-   * @property {string} [reason] Reason for editing this emoji
-   */
-
-  /**
-   * Edits the emoji.
-   * @param {GuildEmojiEditOptions} options The options to provide
-   * @returns {Promise<GuildEmoji>}
-   * @example
-   * // Edit an emoji
-   * emoji.edit({ name: 'newemoji' })
-   *   .then(e => console.log(`Edited emoji ${e}`))
-   *   .catch(console.error);
-   */
+  
+
+  
   edit(options) {
     return this.guild.emojis.edit(this.id, options);
   }
 
-  /**
-   * Sets the name of the emoji.
-   * @param {string} name The new name for the emoji
-   * @param {string} [reason] Reason for changing the emoji's name
-   * @returns {Promise<GuildEmoji>}
-   */
+  
   setName(name, reason) {
     return this.edit({ name, reason });
   }
 
-  /**
-   * Deletes the emoji.
-   * @param {string} [reason] Reason for deleting the emoji
-   * @returns {Promise<GuildEmoji>}
-   */
+  
   async delete(reason) {
     await this.guild.emojis.delete(this.id, reason);
     return this;
   }
 
-  /**
-   * Whether this emoji is the same as another one.
-   * @param {GuildEmoji|APIEmoji} other The emoji to compare it to
-   * @returns {boolean}
-   */
+  
   equals(other) {
     if (other instanceof GuildEmoji) {
       return (