@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/StringSelectMenuBuilder.js

@@ -5,10 +5,7 @@ const { isJSONEncodable } = require('@discordjs/util');
 const { toSnakeCase } = require('../util/Transformers');
 const { resolvePartialEmoji } = require('../util/Util');
 
-/**
- * Class used to build select menu components to be sent through the API
- * @extends {BuildersSelectMenu}
- */
+
 class StringSelectMenuBuilder extends BuildersSelectMenu {
   constructor({ options, ...data } = {}) {
     super(
@@ -22,12 +19,7 @@ class StringSelectMenuBuilder extends BuildersSelectMenu {
     );
   }
 
-  /**
-   * Normalizes a select menu option emoji
-   * @param {SelectMenuOptionData|APISelectMenuOption} selectMenuOption The option to normalize
-   * @returns {SelectMenuOptionBuilder|APISelectMenuOption}
-   * @private
-   */
+  
   static normalizeEmoji(selectMenuOption) {
     if (isJSONEncodable(selectMenuOption)) {
       return selectMenuOption;
@@ -40,29 +32,17 @@ class StringSelectMenuBuilder extends BuildersSelectMenu {
     };
   }
 
-  /**
-   * Adds options to this select menu
-   * @param {RestOrArray<APISelectMenuOption>} options The options to add to this select menu
-   * @returns {StringSelectMenuBuilder}
-   */
+  
   addOptions(...options) {
     return super.addOptions(normalizeArray(options).map(option => StringSelectMenuBuilder.normalizeEmoji(option)));
   }
 
-  /**
-   * Sets the options on this select menu
-   * @param {RestOrArray<APISelectMenuOption>} options The options to set on this select menu
-   * @returns {StringSelectMenuBuilder}
-   */
+  
   setOptions(...options) {
     return super.setOptions(normalizeArray(options).map(option => StringSelectMenuBuilder.normalizeEmoji(option)));
   }
 
-  /**
-   * Creates a new select menu builder from json data
-   * @param {StringSelectMenuBuilder|StringSelectMenuComponent|APIStringSelectComponent} other The other data
-   * @returns {StringSelectMenuBuilder}
-   */
+  
   static from(other) {
     if (isJSONEncodable(other)) {
       return new this(other.toJSON());
@@ -73,7 +53,4 @@ class StringSelectMenuBuilder extends BuildersSelectMenu {
 
 module.exports = StringSelectMenuBuilder;
 
-/**
- * @external BuildersSelectMenu
- * @see {@link https://discord.js.org/docs/packages/builders/stable/StringSelectMenuBuilder:Class}
- */
+

package/src/structures/StringSelectMenuComponent.js

@@ -2,16 +2,9 @@
 
 const BaseSelectMenuComponent = require('./BaseSelectMenuComponent');
 
-/**
- * Represents a string select menu component
- * @extends {BaseSelectMenuComponent}
- */
+
 class StringSelectMenuComponent extends BaseSelectMenuComponent {
-  /**
-   * The options in this select menu
-   * @type {APISelectMenuOption[]}
-   * @readonly
-   */
+  
   get options() {
     return this.data.options;
   }

package/src/structures/StringSelectMenuInteraction.js

@@ -2,18 +2,12 @@
 
 const MessageComponentInteraction = require('./MessageComponentInteraction');
 
-/**
- * Represents a {@link ComponentType.StringSelect} select menu interaction.
- * @extends {MessageComponentInteraction}
- */
+
 class StringSelectMenuInteraction extends MessageComponentInteraction {
   constructor(client, data) {
     super(client, data);
 
-    /**
-     * The values selected
-     * @type {string[]}
-     */
+    
     this.values = data.data.values ?? [];
   }
 }

package/src/structures/StringSelectMenuOptionBuilder.js

@@ -5,10 +5,7 @@ const { isJSONEncodable } = require('@discordjs/util');
 const { toSnakeCase } = require('../util/Transformers');
 const { resolvePartialEmoji } = require('../util/Util');
 
-/**
- * Represents a select menu option builder.
- * @extends {BuildersSelectMenuOption}
- */
+
 class StringSelectMenuOptionBuilder extends BuildersSelectMenuOption {
   constructor({ emoji, ...data } = {}) {
     super(
@@ -19,11 +16,7 @@ class StringSelectMenuOptionBuilder extends BuildersSelectMenuOption {
     );
   }
 
-  /**
-   * Sets the emoji to display on this option
-   * @param {ComponentEmojiResolvable} emoji The emoji to display on this option
-   * @returns {StringSelectMenuOptionBuilder}
-   */
+  
   setEmoji(emoji) {
     if (typeof emoji === 'string') {
       return super.setEmoji(resolvePartialEmoji(emoji));
@@ -31,11 +24,7 @@ class StringSelectMenuOptionBuilder extends BuildersSelectMenuOption {
     return super.setEmoji(emoji);
   }
 
-  /**
-   * Creates a new select menu option builder from JSON data
-   * @param {StringSelectMenuOptionBuilder|APISelectMenuOption} other The other data
-   * @returns {StringSelectMenuOptionBuilder}
-   */
+  
   static from(other) {
     return new this(isJSONEncodable(other) ? other.toJSON() : other);
   }
@@ -43,7 +32,4 @@ class StringSelectMenuOptionBuilder extends BuildersSelectMenuOption {
 
 module.exports = StringSelectMenuOptionBuilder;
 
-/**
- * @external BuildersSelectMenuOption
- * @see {@link https://discord.js.org/docs/packages/builders/stable/SelectMenuOptionBuilder:Class}
- */
+

package/src/structures/Team.js

@@ -5,10 +5,7 @@ const { DiscordSnowflake } = require('@sapphire/snowflake');
 const Base = require('./Base');
 const TeamMember = require('./TeamMember');
 
-/**
- * Represents a Client OAuth2 Application Team.
- * @extends {Base}
- */
+
 class Team extends Base {
   constructor(client, data) {
     super(client);
@@ -16,43 +13,28 @@ class Team extends Base {
   }
 
   _patch(data) {
-    /**
-     * The Team's id
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
 
     if ('name' in data) {
-      /**
-       * The name of the Team
-       * @type {string}
-       */
+      
       this.name = data.name;
     }
 
     if ('icon' in data) {
-      /**
-       * The Team's icon hash
-       * @type {?string}
-       */
+      
       this.icon = data.icon;
     } else {
       this.icon ??= null;
     }
 
     if ('owner_user_id' in data) {
-      /**
-       * The Team's owner id
-       * @type {?Snowflake}
-       */
+      
       this.ownerId = data.owner_user_id;
     } else {
       this.ownerId ??= null;
     }
-    /**
-     * The Team's members
-     * @type {Collection<Snowflake, TeamMember>}
-     */
+    
     this.members = new Collection();
 
     for (const memberData of data.members) {
@@ -61,50 +43,27 @@ class Team extends Base {
     }
   }
 
-  /**
-   * The owner of this team
-   * @type {?TeamMember}
-   * @readonly
-   */
+  
   get owner() {
     return this.members.get(this.ownerId) ?? null;
   }
 
-  /**
-   * The timestamp the team was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time the team was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }
 
-  /**
-   * A link to the team's icon.
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   iconURL(options = {}) {
     return this.icon && this.client.rest.cdn.teamIcon(this.id, this.icon, options);
   }
 
-  /**
-   * When concatenated with a string, this automatically returns the Team's name instead of the
-   * Team object.
-   * @returns {string}
-   * @example
-   * // Logs: Team name: My Team
-   * console.log(`Team name: ${team}`);
-   */
+  
   toString() {
     return this.name;
   }

package/src/structures/TeamMember.js

@@ -2,18 +2,12 @@
 
 const Base = require('./Base');
 
-/**
- * Represents a Client OAuth2 Application Team Member.
- * @extends {Base}
- */
+
 class TeamMember extends Base {
   constructor(team, data) {
     super(team.client);
 
-    /**
-     * The Team this member is part of
-     * @type {Team}
-     */
+    
     this.team = team;
 
     this._patch(data);
@@ -21,47 +15,27 @@ class TeamMember extends Base {
 
   _patch(data) {
     if ('permissions' in data) {
-      /**
-       * The permissions this Team Member has with regard to the team
-       * @type {string[]}
-       */
+      
       this.permissions = data.permissions;
     }
 
     if ('membership_state' in data) {
-      /**
-       * The permissions this Team Member has with regard to the team
-       * @type {TeamMemberMembershipState}
-       */
+      
       this.membershipState = data.membership_state;
     }
 
     if ('user' in data) {
-      /**
-       * The user for this Team Member
-       * @type {User}
-       */
+      
       this.user = this.client.users._add(data.user);
     }
   }
 
-  /**
-   * The Team Member's id
-   * @type {Snowflake}
-   * @readonly
-   */
+  
   get id() {
     return this.user.id;
   }
 
-  /**
-   * When concatenated with a string, this automatically returns the team member's mention instead of the
-   * TeamMember object.
-   * @returns {string}
-   * @example
-   * // Logs: Team Member's mention: <@123456789012345678>
-   * console.log(`Team Member's mention: ${teamMember}`);
-   */
+  
   toString() {
     return this.user.toString();
   }

package/src/structures/TextChannel.js

@@ -2,29 +2,18 @@
 
 const BaseGuildTextChannel = require('./BaseGuildTextChannel');
 
-/**
- * Represents a guild text channel on Discord.
- * @extends {BaseGuildTextChannel}
- */
+
 class TextChannel extends BaseGuildTextChannel {
   _patch(data) {
     super._patch(data);
 
     if ('rate_limit_per_user' in data) {
-      /**
-       * The rate limit per user (slowmode) for this channel in seconds
-       * @type {number}
-       */
+      
       this.rateLimitPerUser = data.rate_limit_per_user;
     }
   }
 
-  /**
-   * Sets the rate limit per user (slowmode) for this channel.
-   * @param {number} rateLimitPerUser The new rate limit in seconds
-   * @param {string} [reason] Reason for changing the channel's rate limit
-   * @returns {Promise<TextChannel>}
-   */
+  
   setRateLimitPerUser(rateLimitPerUser, reason) {
     return this.edit({ rateLimitPerUser, reason });
   }

package/src/structures/TextInputBuilder.js

@@ -4,20 +4,13 @@ const { TextInputBuilder: BuildersTextInput } = require('@discordjs/builders');
 const { isJSONEncodable } = require('@discordjs/util');
 const { toSnakeCase } = require('../util/Transformers');
 
-/**
- * Represents a text input builder.
- * @extends {BuildersTextInput}
- */
+
 class TextInputBuilder extends BuildersTextInput {
   constructor(data) {
     super(toSnakeCase(data));
   }
 
-  /**
-   * Creates a new text input builder from JSON data
-   * @param {TextInputBuilder|TextInputComponent|APITextInputComponent} other The other data
-   * @returns {TextInputBuilder}
-   */
+  
   static from(other) {
     return new this(isJSONEncodable(other) ? other.toJSON() : other);
   }
@@ -25,7 +18,4 @@ class TextInputBuilder extends BuildersTextInput {
 
 module.exports = TextInputBuilder;
 
-/**
- * @external BuildersTextInput
- * @see {@link https://discord.js.org/docs/packages/builders/stable/TextInputBuilder:Class}
- */
+

package/src/structures/TextInputComponent.js

@@ -2,25 +2,14 @@
 
 const Component = require('./Component');
 
-/**
- * Represents a text input component.
- * @extends {Component}
- */
+
 class TextInputComponent extends Component {
-  /**
-   * The custom id of this text input
-   * @type {string}
-   * @readonly
-   */
+  
   get customId() {
     return this.data.custom_id;
   }
 
-  /**
-   * The value for this text input
-   * @type {string}
-   * @readonly
-   */
+  
   get value() {
     return this.data.value;
   }