@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/WidgetMember.js

@@ -2,96 +2,50 @@
 
 const Base = require('./Base');
 
-/**
- * Represents a WidgetMember.
- * @extends {Base}
- */
+
 class WidgetMember extends Base {
-  /**
-   * Activity sent in a {@link WidgetMember}.
-   * @typedef {Object} WidgetActivity
-   * @property {string} name The name of the activity
-   */
+  
 
   constructor(client, data) {
     super(client);
 
-    /**
-     * The id of the user. It's an arbitrary number.
-     * @type {string}
-     */
+    
     this.id = data.id;
 
-    /**
-     * The username of the member.
-     * @type {string}
-     */
+    
     this.username = data.username;
 
-    /**
-     * The discriminator of the member.
-     * @type {string}
-     */
+    
     this.discriminator = data.discriminator;
 
-    /**
-     * The avatar of the member.
-     * @type {?string}
-     */
+    
     this.avatar = data.avatar;
 
-    /**
-     * The status of the member.
-     * @type {PresenceStatus}
-     */
+    
     this.status = data.status;
 
-    /**
-     * If the member is server deafened
-     * @type {?boolean}
-     */
+    
     this.deaf = data.deaf ?? null;
 
-    /**
-     * If the member is server muted
-     * @type {?boolean}
-     */
+    
     this.mute = data.mute ?? null;
 
-    /**
-     * If the member is self deafened
-     * @type {?boolean}
-     */
+    
     this.selfDeaf = data.self_deaf ?? null;
 
-    /**
-     * If the member is self muted
-     * @type {?boolean}
-     */
+    
     this.selfMute = data.self_mute ?? null;
 
-    /**
-     * If the member is suppressed
-     * @type {?boolean}
-     */
+    
     this.suppress = data.suppress ?? null;
 
-    /**
-     * The id of the voice channel the member is in, if any
-     * @type {?Snowflake}
-     */
+    
     this.channelId = data.channel_id ?? null;
 
-    /**
-     * The avatar URL of the member.
-     * @type {string}
-     */
+    
     this.avatarURL = data.avatar_url;
 
-    /**
-     * The activity of the member.
-     * @type {?WidgetActivity}
-     */
+    
     this.activity = data.activity ?? null;
   }
 }

package/src/structures/interfaces/Application.js

@@ -3,11 +3,7 @@
 const { DiscordSnowflake } = require('@sapphire/snowflake');
 const Base = require('../Base');
 
-/**
- * Represents an OAuth2 Application.
- * @extends {Base}
- * @abstract
- */
+
 class Application extends Base {
   constructor(client, data) {
     super(client);
@@ -15,87 +11,52 @@ class Application extends Base {
   }
 
   _patch(data) {
-    /**
-     * The application's id
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
 
     if ('name' in data) {
-      /**
-       * The name of the application
-       * @type {?string}
-       */
+      
       this.name = data.name;
     } else {
       this.name ??= null;
     }
 
     if ('description' in data) {
-      /**
-       * The application's description
-       * @type {?string}
-       */
+      
       this.description = data.description;
     } else {
       this.description ??= null;
     }
 
     if ('icon' in data) {
-      /**
-       * The application's icon hash
-       * @type {?string}
-       */
+      
       this.icon = data.icon;
     } else {
       this.icon ??= null;
     }
   }
 
-  /**
-   * The timestamp the application was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time the application was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }
 
-  /**
-   * A link to the application's icon.
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   iconURL(options = {}) {
     return this.icon && this.client.rest.cdn.appIcon(this.id, this.icon, options);
   }
 
-  /**
-   * A link to this application's cover image.
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   coverURL(options = {}) {
     return this.cover && this.client.rest.cdn.appIcon(this.id, this.cover, options);
   }
 
-  /**
-   * When concatenated with a string, this automatically returns the application's name instead of the
-   * Application object.
-   * @returns {?string}
-   * @example
-   * // Logs: Application name: My App
-   * console.log(`Application name: ${application}`);
-   */
+  
   toString() {
     return this.name;
   }

package/src/structures/interfaces/Collector.js

@@ -6,84 +6,37 @@ const { Collection } = require('@discordjs/collection');
 const { DiscordjsTypeError, ErrorCodes } = require('../../errors');
 const { flatten } = require('../../util/Util');
 
-/**
- * Filter to be applied to the collector.
- * @typedef {Function} CollectorFilter
- * @param {...*} args Any arguments received by the listener
- * @param {Collection} collection The items collected by this collector
- * @returns {boolean|Promise<boolean>}
- */
-
-/**
- * Options to be applied to the collector.
- * @typedef {Object} CollectorOptions
- * @property {CollectorFilter} [filter] The filter applied to this collector
- * @property {number} [time] How long to run the collector for in milliseconds
- * @property {number} [idle] How long to stop the collector after inactivity in milliseconds
- * @property {boolean} [dispose=false] Whether to dispose data when it's deleted
- */
-
-/**
- * Abstract class for defining a new Collector.
- * @extends {EventEmitter}
- * @abstract
- */
+
+
+
+
+
 class Collector extends EventEmitter {
   constructor(client, options = {}) {
     super();
 
-    /**
-     * The client that instantiated this Collector
-     * @name Collector#client
-     * @type {Client}
-     * @readonly
-     */
+    
     Object.defineProperty(this, 'client', { value: client });
 
-    /**
-     * The filter applied to this collector
-     * @type {CollectorFilter}
-     * @returns {boolean|Promise<boolean>}
-     */
+    
     this.filter = options.filter ?? (() => true);
 
-    /**
-     * The options of this collector
-     * @type {CollectorOptions}
-     */
+    
     this.options = options;
 
-    /**
-     * The items collected by this collector
-     * @type {Collection}
-     */
+    
     this.collected = new Collection();
 
-    /**
-     * Whether this collector has finished collecting
-     * @type {boolean}
-     */
+    
     this.ended = false;
 
-    /**
-     * Timeout for cleanup
-     * @type {?Timeout}
-     * @private
-     */
+    
     this._timeout = null;
 
-    /**
-     * Timeout for cleanup due to inactivity
-     * @type {?Timeout}
-     * @private
-     */
+    
     this._idletimeout = null;
 
-    /**
-     * The reason the collector ended
-     * @type {string|null}
-     * @private
-     */
+    
     this._endReason = null;
 
     if (typeof this.filter !== 'function') {
@@ -96,27 +49,16 @@ class Collector extends EventEmitter {
     if (options.time) this._timeout = setTimeout(() => this.stop('time'), options.time).unref();
     if (options.idle) this._idletimeout = setTimeout(() => this.stop('idle'), options.idle).unref();
 
-    /**
-     * The timestamp at which this collector last collected an item
-     * @type {?number}
-     */
+    
     this.lastCollectedTimestamp = null;
   }
 
-  /**
-   * The Date at which this collector last collected an item
-   * @type {?Date}
-   */
+  
   get lastCollectedAt() {
     return this.lastCollectedTimestamp && new Date(this.lastCollectedTimestamp);
   }
 
-  /**
-   * Call this to handle an event as a collectable element. Accepts any event data as parameters.
-   * @param {...*} args The arguments emitted by the listener
-   * @returns {Promise<void>}
-   * @emits Collector#collect
-   */
+  
   async handleCollect(...args) {
     const collectedId = await this.collect(...args);
 
@@ -125,11 +67,7 @@ class Collector extends EventEmitter {
       if (filterResult) {
         this.collected.set(collectedId, args[0]);
 
-        /**
-         * Emitted whenever an element is collected.
-         * @event Collector#collect
-         * @param {...*} args The arguments emitted by the listener
-         */
+        
         this.emit('collect', ...args);
 
         this.lastCollectedTimestamp = Date.now();
@@ -138,23 +76,14 @@ class Collector extends EventEmitter {
           this._idletimeout = setTimeout(() => this.stop('idle'), this.options.idle).unref();
         }
       } else {
-        /**
-         * Emitted whenever an element is not collected by the collector.
-         * @event Collector#ignore
-         * @param {...*} args The arguments emitted by the listener
-         */
+        
         this.emit('ignore', ...args);
       }
     }
     this.checkEnd();
   }
 
-  /**
-   * Call this to remove an element from the collection. Accepts any event data as parameters.
-   * @param {...*} args The arguments emitted by the listener
-   * @returns {Promise<void>}
-   * @emits Collector#dispose
-   */
+  
   async handleDispose(...args) {
     if (!this.options.dispose) return;
 
@@ -162,21 +91,12 @@ class Collector extends EventEmitter {
     if (!dispose || !(await this.filter(...args)) || !this.collected.has(dispose)) return;
     this.collected.delete(dispose);
 
-    /**
-     * Emitted whenever an element is disposed of.
-     * @event Collector#dispose
-     * @param {...*} args The arguments emitted by the listener
-     */
+    
     this.emit('dispose', ...args);
     this.checkEnd();
   }
 
-  /**
-   * Returns a promise that resolves with the next collected element;
-   * rejects with collected elements if the collector finishes without receiving a next element
-   * @type {Promise}
-   * @readonly
-   */
+  
   get next() {
     return new Promise((resolve, reject) => {
       if (this.ended) {
@@ -204,11 +124,7 @@ class Collector extends EventEmitter {
     });
   }
 
-  /**
-   * Stops this collector and emits the `end` event.
-   * @param {string} [reason='user'] The reason this collector is ending
-   * @emits Collector#end
-   */
+  
   stop(reason = 'user') {
     if (this.ended) return;
 
@@ -224,26 +140,13 @@ class Collector extends EventEmitter {
     this._endReason = reason;
     this.ended = true;
 
-    /**
-     * Emitted when the collector is finished collecting.
-     * @event Collector#end
-     * @param {Collection} collected The elements collected by the collector
-     * @param {string} reason The reason the collector ended
-     */
+    
     this.emit('end', this.collected, reason);
   }
 
-  /**
-   * Options used to reset the timeout and idle timer of a {@link Collector}.
-   * @typedef {Object} CollectorResetTimerOptions
-   * @property {number} [time] How long to run the collector for (in milliseconds)
-   * @property {number} [idle] How long to wait to stop the collector after inactivity (in milliseconds)
-   */
-
-  /**
-   * Resets the collector's timeout and idle timer.
-   * @param {CollectorResetTimerOptions} [options] Options for resetting
-   */
+  
+
+  
   resetTimer({ time, idle } = {}) {
     if (this._timeout) {
       clearTimeout(this._timeout);
@@ -255,20 +158,14 @@ class Collector extends EventEmitter {
     }
   }
 
-  /**
-   * Checks whether the collector should end, and if so, ends it.
-   * @returns {boolean} Whether the collector ended or not
-   */
+  
   checkEnd() {
     const reason = this.endReason;
     if (reason) this.stop(reason);
     return Boolean(reason);
   }
 
-  /**
-   * Allows collectors to be consumed with for-await-of loops
-   * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of}
-   */
+  
   async *[Symbol.asyncIterator]() {
     const queue = [];
     const onCollect = (...item) => queue.push(item);
@@ -279,7 +176,7 @@ class Collector extends EventEmitter {
         if (queue.length) {
           yield queue.shift();
         } else {
-          // eslint-disable-next-line no-await-in-loop
+          
           await new Promise(resolve => {
             const tick = () => {
               this.removeListener('collect', tick);
@@ -300,36 +197,18 @@ class Collector extends EventEmitter {
     return flatten(this);
   }
 
-  /* eslint-disable no-empty-function */
-  /**
-   * The reason this collector has ended with, or null if it hasn't ended yet
-   * @type {?string}
-   * @readonly
-   */
+  
+  
   get endReason() {
     return this._endReason;
   }
 
-  /**
-   * Handles incoming events from the `handleCollect` function. Returns null if the event should not
-   * be collected, or returns an object describing the data that should be stored.
-   * @see Collector#handleCollect
-   * @param {...*} args Any args the event listener emits
-   * @returns {?(*|Promise<?*>)} Data to insert into collection, if any
-   * @abstract
-   */
+  
   collect() {}
 
-  /**
-   * Handles incoming events from the `handleDispose`. Returns null if the event should not
-   * be disposed, or returns the key that should be removed.
-   * @see Collector#handleDispose
-   * @param {...*} args Any args the event listener emits
-   * @returns {?*} Key to remove from the collection, if any
-   * @abstract
-   */
+  
   dispose() {}
-  /* eslint-enable no-empty-function */
+  
 }
 
 module.exports = Collector;