@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/ThreadMember.js

@@ -3,36 +3,21 @@
 const Base = require('./Base');
 const ThreadMemberFlagsBitField = require('../util/ThreadMemberFlagsBitField');
 
-/**
- * Represents a Member for a Thread.
- * @extends {Base}
- */
+
 class ThreadMember extends Base {
   constructor(thread, data, extra = {}) {
     super(thread.client);
 
-    /**
-     * The thread that this member is a part of
-     * @type {ThreadChannel}
-     */
+    
     this.thread = thread;
 
-    /**
-     * The timestamp the member last joined the thread at
-     * @type {?number}
-     */
+    
     this.joinedTimestamp = null;
 
-    /**
-     * The flags for this thread member. This will be `null` if partial.
-     * @type {?ThreadMemberFlagsBitField}
-     */
+    
     this.flags = null;
 
-    /**
-     * The id of the thread member
-     * @type {Snowflake}
-     */
+    
     this.id = data.user_id;
 
     this._patch(data, extra);
@@ -43,67 +28,39 @@ class ThreadMember extends Base {
     if ('flags' in data) this.flags = new ThreadMemberFlagsBitField(data.flags).freeze();
 
     if ('member' in data) {
-      /**
-       * The guild member associated with this thread member.
-       * @type {?GuildMember}
-       * @private
-       */
+      
       this.member = this.thread.guild.members._add(data.member, extra.cache);
     } else {
       this.member ??= null;
     }
   }
 
-  /**
-   * Whether this thread member is a partial
-   * @type {boolean}
-   * @readonly
-   */
+  
   get partial() {
     return this.flags === null;
   }
 
-  /**
-   * The guild member associated with this thread member
-   * @type {?GuildMember}
-   * @readonly
-   */
+  
   get guildMember() {
     return this.member ?? this.thread.guild.members.resolve(this.id);
   }
 
-  /**
-   * The last time this member joined the thread
-   * @type {?Date}
-   * @readonly
-   */
+  
   get joinedAt() {
     return this.joinedTimestamp && new Date(this.joinedTimestamp);
   }
 
-  /**
-   * The user associated with this thread member
-   * @type {?User}
-   * @readonly
-   */
+  
   get user() {
     return this.client.users.resolve(this.id);
   }
 
-  /**
-   * Whether the client user can manage this thread member
-   * @type {boolean}
-   * @readonly
-   */
+  
   get manageable() {
     return !this.thread.archived && this.thread.editable;
   }
 
-  /**
-   * Removes this member from the thread.
-   * @param {string} [reason] Reason for removing the member
-   * @returns {ThreadMember}
-   */
+  
   async remove(reason) {
     await this.thread.members.remove(this.id, reason);
     return this;

package/src/structures/Typing.js

@@ -2,24 +2,15 @@
 
 const Base = require('./Base');
 
-/**
- * Represents a typing state for a user in a channel.
- * @extends {Base}
- */
+
 class Typing extends Base {
   constructor(channel, user, data) {
     super(channel.client);
 
-    /**
-     * The channel the status is from
-     * @type {TextBasedChannels}
-     */
+    
     this.channel = channel;
 
-    /**
-     * The user who is typing
-     * @type {User}
-     */
+    
     this.user = user;
 
     this._patch(data);
@@ -27,45 +18,27 @@ class Typing extends Base {
 
   _patch(data) {
     if ('timestamp' in data) {
-      /**
-       * The UNIX timestamp in milliseconds the user started typing at
-       * @type {number}
-       */
+      
       this.startedTimestamp = data.timestamp * 1_000;
     }
   }
 
-  /**
-   * Indicates whether the status is received from a guild.
-   * @returns {boolean}
-   */
+  
   inGuild() {
     return this.guild !== null;
   }
 
-  /**
-   * The time the user started typing at
-   * @type {Date}
-   * @readonly
-   */
+  
   get startedAt() {
     return new Date(this.startedTimestamp);
   }
 
-  /**
-   * The guild the status is from
-   * @type {?Guild}
-   * @readonly
-   */
+  
   get guild() {
     return this.channel.guild ?? null;
   }
 
-  /**
-   * The member who is typing
-   * @type {?GuildMember}
-   * @readonly
-   */
+  
   get member() {
     return this.guild?.members.resolve(this.user) ?? null;
   }

package/src/structures/User.js

@@ -6,19 +6,12 @@ const Base = require('./Base');
 const TextBasedChannel = require('./interfaces/TextBasedChannel');
 const UserFlagsBitField = require('../util/UserFlagsBitField');
 
-/**
- * Represents a user on Discord.
- * @implements {TextBasedChannel}
- * @extends {Base}
- */
+
 class User extends Base {
   constructor(client, data) {
     super(client);
 
-    /**
-     * The user's id
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
 
     this.bot = null;
@@ -32,203 +25,122 @@ class User extends Base {
 
   _patch(data) {
     if ('username' in data) {
-      /**
-       * The username of the user
-       * @type {?string}
-       */
+      
       this.username = data.username;
     } else {
       this.username ??= null;
     }
 
     if ('bot' in data) {
-      /**
-       * Whether or not the user is a bot
-       * @type {?boolean}
-       */
+      
       this.bot = Boolean(data.bot);
     } else if (!this.partial && typeof this.bot !== 'boolean') {
       this.bot = false;
     }
 
     if ('discriminator' in data) {
-      /**
-       * A discriminator based on username for the user
-       * @type {?string}
-       */
+      
       this.discriminator = data.discriminator;
     } else {
       this.discriminator ??= null;
     }
 
     if ('avatar' in data) {
-      /**
-       * The user avatar's hash
-       * @type {?string}
-       */
+      
       this.avatar = data.avatar;
     } else {
       this.avatar ??= null;
     }
 
     if ('banner' in data) {
-      /**
-       * The user banner's hash
-       * <info>The user must be force fetched for this property to be present or be updated</info>
-       * @type {?string}
-       */
+      
       this.banner = data.banner;
     } else if (this.banner !== null) {
       this.banner ??= undefined;
     }
 
     if ('accent_color' in data) {
-      /**
-       * The base 10 accent color of the user's banner
-       * <info>The user must be force fetched for this property to be present or be updated</info>
-       * @type {?number}
-       */
+      
       this.accentColor = data.accent_color;
     } else if (this.accentColor !== null) {
       this.accentColor ??= undefined;
     }
 
     if ('system' in data) {
-      /**
-       * Whether the user is an Official Discord System user (part of the urgent message system)
-       * @type {?boolean}
-       */
+      
       this.system = Boolean(data.system);
     } else if (!this.partial && typeof this.system !== 'boolean') {
       this.system = false;
     }
 
     if ('public_flags' in data) {
-      /**
-       * The flags for this user
-       * @type {?UserFlagsBitField}
-       */
+      
       this.flags = new UserFlagsBitField(data.public_flags);
     }
   }
 
-  /**
-   * Whether this User is a partial
-   * @type {boolean}
-   * @readonly
-   */
+  
   get partial() {
     return typeof this.username !== 'string';
   }
 
-  /**
-   * The timestamp the user was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time the user was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }
 
-  /**
-   * A link to the user's avatar.
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   avatarURL(options = {}) {
     return this.avatar && this.client.rest.cdn.avatar(this.id, this.avatar, options);
   }
 
-  /**
-   * A link to the user's default avatar
-   * @type {string}
-   * @readonly
-   */
+  
   get defaultAvatarURL() {
     return this.client.rest.cdn.defaultAvatar(this.discriminator % 5);
   }
 
-  /**
-   * A link to the user's avatar if they have one.
-   * Otherwise a link to their default avatar will be returned.
-   * @param {ImageURLOptions} [options={}] Options for the Image URL
-   * @returns {string}
-   */
+  
   displayAvatarURL(options) {
     return this.avatarURL(options) ?? this.defaultAvatarURL;
   }
 
-  /**
-   * The hexadecimal version of the user accent color, with a leading hash
-   * <info>The user must be force fetched for this property to be present</info>
-   * @type {?string}
-   * @readonly
-   */
+  
   get hexAccentColor() {
     if (typeof this.accentColor !== 'number') return this.accentColor;
     return `#${this.accentColor.toString(16).padStart(6, '0')}`;
   }
 
-  /**
-   * A link to the user's banner. See {@link User#banner} for more info
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   bannerURL(options = {}) {
     return this.banner && this.client.rest.cdn.banner(this.id, this.banner, options);
   }
 
-  /**
-   * The Discord "tag" (e.g. `hydrabolt#0001`) for this user
-   * @type {?string}
-   * @readonly
-   */
+  
   get tag() {
     return typeof this.username === 'string' ? `${this.username}#${this.discriminator}` : null;
   }
 
-  /**
-   * The DM between the client's user and this user
-   * @type {?DMChannel}
-   * @readonly
-   */
+  
   get dmChannel() {
     return this.client.users.dmChannel(this.id);
   }
 
-  /**
-   * Creates a DM channel between the client and the user.
-   * @param {boolean} [force=false] Whether to skip the cache check and request the API
-   * @returns {Promise<DMChannel>}
-   */
+  
   createDM(force = false) {
     return this.client.users.createDM(this.id, { force });
   }
 
-  /**
-   * Deletes a DM channel (if one exists) between the client and the user. Resolves with the channel if successful.
-   * @returns {Promise<DMChannel>}
-   */
+  
   deleteDM() {
     return this.client.users.deleteDM(this.id);
   }
 
-  /**
-   * Checks if the user is equal to another.
-   * It compares id, username, discriminator, avatar, banner, accent color, and bot flags.
-   * It is recommended to compare equality by using `user.id === user2.id` unless you want to compare all properties.
-   * @param {User} user User to compare with
-   * @returns {boolean}
-   */
+  
   equals(user) {
     return (
       user &&
@@ -242,12 +154,7 @@ class User extends Base {
     );
   }
 
-  /**
-   * Compares the user with an API user object
-   * @param {APIUser} user The API user object to compare
-   * @returns {boolean}
-   * @private
-   */
+  
   _equals(user) {
     return (
       user &&
@@ -261,31 +168,17 @@ class User extends Base {
     );
   }
 
-  /**
-   * Fetches this user's flags.
-   * @param {boolean} [force=false] Whether to skip the cache check and request the API
-   * @returns {Promise<UserFlagsBitField>}
-   */
+  
   fetchFlags(force = false) {
     return this.client.users.fetchFlags(this.id, { force });
   }
 
-  /**
-   * Fetches this user.
-   * @param {boolean} [force=true] Whether to skip the cache check and request the API
-   * @returns {Promise<User>}
-   */
+  
   fetch(force = true) {
     return this.client.users.fetch(this.id, { force });
   }
 
-  /**
-   * When concatenated with a string, this automatically returns the user's mention instead of the User object.
-   * @returns {string}
-   * @example
-   * // Logs: Hello from <@123456789012345678>!
-   * console.log(`Hello from ${user}!`);
-   */
+  
   toString() {
     return userMention(this.id);
   }
@@ -307,25 +200,10 @@ class User extends Base {
   }
 }
 
-/**
- * Sends a message to this user.
- * @method send
- * @memberof User
- * @instance
- * @param {string|MessagePayload|MessageCreateOptions} options The options to provide
- * @returns {Promise<Message>}
- * @example
- * // Send a direct message
- * user.send('Hello!')
- *   .then(message => console.log(`Sent message: ${message.content} to ${user.tag}`))
- *   .catch(console.error);
- */
+
 
 TextBasedChannel.applyToClass(User);
 
 module.exports = User;
 
-/**
- * @external APIUser
- * @see {@link https://discord.com/developers/docs/resources/user#user-object}
- */
+

package/src/structures/UserContextMenuCommandInteraction.js

@@ -2,25 +2,14 @@
 
 const ContextMenuCommandInteraction = require('./ContextMenuCommandInteraction');
 
-/**
- * Represents a user context menu interaction.
- * @extends {ContextMenuCommandInteraction}
- */
+
 class UserContextMenuCommandInteraction extends ContextMenuCommandInteraction {
-  /**
-   * The target user from this interaction
-   * @type {User}
-   * @readonly
-   */
+  
   get targetUser() {
     return this.options.getUser('user');
   }
 
-  /**
-   * The target member from this interaction
-   * @type {?(GuildMember|APIGuildMember)}
-   * @readonly
-   */
+  
   get targetMember() {
     return this.options.getMember('user');
   }

package/src/structures/UserSelectMenuBuilder.js

@@ -4,20 +4,13 @@ const { UserSelectMenuBuilder: BuildersUserSelectMenu } = require('@discordjs/bu
 const { isJSONEncodable } = require('@discordjs/util');
 const { toSnakeCase } = require('../util/Transformers');
 
-/**
- * Class used to build select menu components to be sent through the API
- * @extends {BuildersUserSelectMenu}
- */
+
 class UserSelectMenuBuilder extends BuildersUserSelectMenu {
   constructor(data = {}) {
     super(toSnakeCase(data));
   }
 
-  /**
-   * Creates a new select menu builder from JSON data
-   * @param {UserSelectMenuBuilder|UserSelectMenuComponent|APIUserSelectComponent} other The other data
-   * @returns {UserSelectMenuBuilder}
-   */
+  
   static from(other) {
     return new this(isJSONEncodable(other) ? other.toJSON() : other);
   }
@@ -25,7 +18,4 @@ class UserSelectMenuBuilder extends BuildersUserSelectMenu {
 
 module.exports = UserSelectMenuBuilder;
 
-/**
- * @external BuildersUserSelectMenu
- * @see {@link https://discord.js.org/docs/packages/rest/stable/UserSelectMenuBuilder:Class}
- */
+

package/src/structures/UserSelectMenuComponent.js

@@ -2,10 +2,7 @@
 
 const BaseSelectMenuComponent = require('./BaseSelectMenuComponent');
 
-/**
- * Represents a user select menu component
- * @extends {BaseSelectMenuComponent}
- */
+
 class UserSelectMenuComponent extends BaseSelectMenuComponent {}
 
 module.exports = UserSelectMenuComponent;

package/src/structures/UserSelectMenuInteraction.js

@@ -4,31 +4,19 @@ const { Collection } = require('@discordjs/collection');
 const MessageComponentInteraction = require('./MessageComponentInteraction');
 const Events = require('../util/Events');
 
-/**
- * Represents a {@link ComponentType.UserSelect} select menu interaction.
- * @extends {MessageComponentInteraction}
- */
+
 class UserSelectMenuInteraction extends MessageComponentInteraction {
   constructor(client, data) {
     super(client, data);
     const { resolved, values } = data.data;
 
-    /**
-     * An array of the selected user ids
-     * @type {Snowflake[]}
-     */
+    
     this.values = values ?? [];
 
-    /**
-     * Collection of the selected users
-     * @type {Collection<Snowflake, User>}
-     */
+    
     this.users = new Collection();
 
-    /**
-     * Collection of the selected members
-     * @type {Collection<Snowflake, GuildMember|APIGuildMember>}
-     */
+    
     this.members = new Collection();
 
     for (const user of Object.values(resolved?.users ?? {})) {