@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/StageChannel.js

@@ -2,111 +2,39 @@
 
 const BaseGuildVoiceChannel = require('./BaseGuildVoiceChannel');
 
-/**
- * Represents a guild stage channel on Discord.
- * @extends {BaseGuildVoiceChannel}
- */
+
 class StageChannel extends BaseGuildVoiceChannel {
   _patch(data) {
     super._patch(data);
 
     if ('topic' in data) {
-      /**
-       * The topic of the stage channel
-       * @type {?string}
-       */
+      
       this.topic = data.topic;
     }
   }
 
-  /**
-   * The stage instance of this stage channel, if it exists
-   * @type {?StageInstance}
-   * @readonly
-   */
+  
   get stageInstance() {
     return this.guild.stageInstances.cache.find(stageInstance => stageInstance.channelId === this.id) ?? null;
   }
 
-  /**
-   * Creates a stage instance associated with this stage channel.
-   * @param {StageInstanceCreateOptions} options The options to create the stage instance
-   * @returns {Promise<StageInstance>}
-   */
+  
   createStageInstance(options) {
     return this.guild.stageInstances.create(this.id, options);
   }
 
-  /**
-   * Sets a new topic for the guild channel.
-   * @param {?string} topic The new topic for the guild channel
-   * @param {string} [reason] Reason for changing the guild channel's topic
-   * @returns {Promise<StageChannel>}
-   * @example
-   * // Set a new channel topic
-   * stageChannel.setTopic('needs more rate limiting')
-   *   .then(channel => console.log(`Channel's new topic is ${channel.topic}`))
-   *   .catch(console.error);
-   */
+  
   setTopic(topic, reason) {
     return this.edit({ topic, reason });
   }
 }
 
-/**
- * Sets the bitrate of the channel.
- * @method setBitrate
- * @memberof StageChannel
- * @instance
- * @param {number} bitrate The new bitrate
- * @param {string} [reason] Reason for changing the channel's bitrate
- * @returns {Promise<StageChannel>}
- * @example
- * // Set the bitrate of a voice channel
- * stageChannel.setBitrate(48_000)
- *   .then(channel => console.log(`Set bitrate to ${channel.bitrate}bps for ${channel.name}`))
- *   .catch(console.error);
- */
-
-/**
- * Sets the RTC region of the channel.
- * @method setRTCRegion
- * @memberof StageChannel
- * @instance
- * @param {?string} rtcRegion The new region of the channel. Set to `null` to remove a specific region for the channel
- * @param {string} [reason] The reason for modifying this region.
- * @returns {Promise<StageChannel>}
- * @example
- * // Set the RTC region to sydney
- * stageChannel.setRTCRegion('sydney');
- * @example
- * // Remove a fixed region for this channel - let Discord decide automatically
- * stageChannel.setRTCRegion(null, 'We want to let Discord decide.');
- */
-
-/**
- * Sets the user limit of the channel.
- * @method setUserLimit
- * @memberof StageChannel
- * @instance
- * @param {number} userLimit The new user limit
- * @param {string} [reason] Reason for changing the user limit
- * @returns {Promise<StageChannel>}
- * @example
- * // Set the user limit of a voice channel
- * stageChannel.setUserLimit(42)
- *   .then(channel => console.log(`Set user limit to ${channel.userLimit} for ${channel.name}`))
- *   .catch(console.error);
- */
-
-/**
- * Sets the camera video quality mode of the channel.
- * @method setVideoQualityMode
- * @memberof StageChannel
- * @instance
- * @param {VideoQualityMode} videoQualityMode The new camera video quality mode.
- * @param {string} [reason] Reason for changing the camera video quality mode.
- * @returns {Promise<StageChannel>}
- */
+
+
+
+
+
+
+
 
 module.exports = StageChannel;

package/src/structures/StageInstance.js

@@ -3,18 +3,12 @@
 const { DiscordSnowflake } = require('@sapphire/snowflake');
 const Base = require('./Base');
 
-/**
- * Represents a stage instance.
- * @extends {Base}
- */
+
 class StageInstance extends Base {
   constructor(client, data) {
     super(client);
 
-    /**
-     * The stage instance's id
-     * @type {Snowflake}
-     */
+    
     this.id = data.id;
 
     this._patch(data);
@@ -22,143 +16,78 @@ class StageInstance extends Base {
 
   _patch(data) {
     if ('guild_id' in data) {
-      /**
-       * The id of the guild associated with the stage channel
-       * @type {Snowflake}
-       */
+      
       this.guildId = data.guild_id;
     }
 
     if ('channel_id' in data) {
-      /**
-       * The id of the channel associated with the stage channel
-       * @type {Snowflake}
-       */
+      
       this.channelId = data.channel_id;
     }
 
     if ('topic' in data) {
-      /**
-       * The topic of the stage instance
-       * @type {string}
-       */
+      
       this.topic = data.topic;
     }
 
     if ('privacy_level' in data) {
-      /**
-       * The privacy level of the stage instance
-       * @type {StageInstancePrivacyLevel}
-       */
+      
       this.privacyLevel = data.privacy_level;
     }
 
     if ('discoverable_disabled' in data) {
-      /**
-       * Whether or not stage discovery is disabled
-       * @type {?boolean}
-       * @deprecated See https://github.com/discord/discord-api-docs/pull/4296 for more information
-       */
+      
       this.discoverableDisabled = data.discoverable_disabled;
     } else {
       this.discoverableDisabled ??= null;
     }
 
     if ('guild_scheduled_event_id' in data) {
-      /**
-       * The associated guild scheduled event id of this stage instance
-       * @type {?Snowflake}
-       */
+      
       this.guildScheduledEventId = data.guild_scheduled_event_id;
     } else {
       this.guildScheduledEventId ??= null;
     }
   }
 
-  /**
-   * The stage channel associated with this stage instance
-   * @type {?StageChannel}
-   * @readonly
-   */
+  
   get channel() {
     return this.client.channels.resolve(this.channelId);
   }
 
-  /**
-   * The guild this stage instance belongs to
-   * @type {?Guild}
-   * @readonly
-   */
+  
   get guild() {
     return this.client.guilds.resolve(this.guildId);
   }
 
-  /**
-   * The associated guild scheduled event of this stage instance
-   * @type {?GuildScheduledEvent}
-   * @readonly
-   */
+  
   get guildScheduledEvent() {
     return this.guild?.scheduledEvents.resolve(this.guildScheduledEventId) ?? null;
   }
 
-  /**
-   * Edits this stage instance.
-   * @param {StageInstanceEditOptions} options The options to edit the stage instance
-   * @returns {Promise<StageInstance>}
-   * @example
-   * // Edit a stage instance
-   * stageInstance.edit({ topic: 'new topic' })
-   *  .then(stageInstance => console.log(stageInstance))
-   *  .catch(console.error)
-   */
+  
   edit(options) {
     return this.guild.stageInstances.edit(this.channelId, options);
   }
 
-  /**
-   * Deletes this stage instance.
-   * @returns {Promise<StageInstance>}
-   * @example
-   * // Delete a stage instance
-   * stageInstance.delete()
-   *  .then(stageInstance => console.log(stageInstance))
-   *  .catch(console.error);
-   */
+  
   async delete() {
     await this.guild.stageInstances.delete(this.channelId);
     const clone = this._clone();
     return clone;
   }
 
-  /**
-   * Sets the topic of this stage instance.
-   * @param {string} topic The topic for the stage instance
-   * @returns {Promise<StageInstance>}
-   * @example
-   * // Set topic of a stage instance
-   * stageInstance.setTopic('new topic')
-   *  .then(stageInstance => console.log(`Set the topic to: ${stageInstance.topic}`))
-   *  .catch(console.error);
-   */
+  
   setTopic(topic) {
     return this.guild.stageInstances.edit(this.channelId, { topic });
   }
 
-  /**
-   * The timestamp this stage instances was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time this stage instance was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }

package/src/structures/Sticker.js

@@ -6,10 +6,7 @@ const Base = require('./Base');
 const { DiscordjsError, ErrorCodes } = require('../errors');
 const { StickerFormatExtensionMap } = require('../util/Constants');
 
-/**
- * Represents a Sticker.
- * @extends {Base}
- */
+
 class Sticker extends Base {
   constructor(client, sticker) {
     super(client);
@@ -18,227 +15,134 @@ class Sticker extends Base {
   }
 
   _patch(sticker) {
-    /**
-     * The sticker's id
-     * @type {Snowflake}
-     */
+    
     this.id = sticker.id;
 
     if ('description' in sticker) {
-      /**
-       * The description of the sticker
-       * @type {?string}
-       */
+      
       this.description = sticker.description;
     } else {
       this.description ??= null;
     }
 
     if ('type' in sticker) {
-      /**
-       * The type of the sticker
-       * @type {?StickerType}
-       */
+      
       this.type = sticker.type;
     } else {
       this.type ??= null;
     }
 
     if ('format_type' in sticker) {
-      /**
-       * The format of the sticker
-       * @type {StickerFormatType}
-       */
+      
       this.format = sticker.format_type;
     }
 
     if ('name' in sticker) {
-      /**
-       * The name of the sticker
-       * @type {string}
-       */
+      
       this.name = sticker.name;
     }
 
     if ('pack_id' in sticker) {
-      /**
-       * The id of the pack the sticker is from, for standard stickers
-       * @type {?Snowflake}
-       */
+      
       this.packId = sticker.pack_id;
     } else {
       this.packId ??= null;
     }
 
     if ('tags' in sticker) {
-      /**
-       * Autocomplete/suggestions for the sticker
-       * @type {?string}
-       */
+      
       this.tags = sticker.tags;
     } else {
       this.tags ??= null;
     }
 
     if ('available' in sticker) {
-      /**
-       * Whether or not the guild sticker is available
-       * @type {?boolean}
-       */
+      
       this.available = sticker.available;
     } else {
       this.available ??= null;
     }
 
     if ('guild_id' in sticker) {
-      /**
-       * The id of the guild that owns this sticker
-       * @type {?Snowflake}
-       */
+      
       this.guildId = sticker.guild_id;
     } else {
       this.guildId ??= null;
     }
 
     if ('user' in sticker) {
-      /**
-       * The user that uploaded the guild sticker
-       * @type {?User}
-       */
+      
       this.user = this.client.users._add(sticker.user);
     } else {
       this.user ??= null;
     }
 
     if ('sort_value' in sticker) {
-      /**
-       * The standard sticker's sort order within its pack
-       * @type {?number}
-       */
+      
       this.sortValue = sticker.sort_value;
     } else {
       this.sortValue ??= null;
     }
   }
 
-  /**
-   * The timestamp the sticker was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time the sticker was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }
 
-  /**
-   * Whether this sticker is partial
-   * @type {boolean}
-   * @readonly
-   */
+  
   get partial() {
     return !this.type;
   }
 
-  /**
-   * The guild that owns this sticker
-   * @type {?Guild}
-   * @readonly
-   */
+  
   get guild() {
     return this.client.guilds.resolve(this.guildId);
   }
 
-  /**
-   * A link to the sticker
-   * <info>If the sticker's format is {@link StickerFormatType.Lottie}, it returns
-   * the URL of the Lottie JSON file.</info>
-   * @type {string}
-   * @readonly
-   */
+  
   get url() {
     return this.client.rest.cdn.sticker(this.id, StickerFormatExtensionMap[this.format]);
   }
 
-  /**
-   * Fetches this sticker.
-   * @returns {Promise<Sticker>}
-   */
+  
   async fetch() {
     const data = await this.client.rest.get(Routes.sticker(this.id));
     this._patch(data);
     return this;
   }
 
-  /**
-   * Fetches the pack this sticker is part of from Discord, if this is a Nitro sticker.
-   * @returns {Promise<?StickerPack>}
-   */
+  
   async fetchPack() {
     return (this.packId && (await this.client.fetchPremiumStickerPacks()).get(this.packId)) ?? null;
   }
 
-  /**
-   * Fetches the user who uploaded this sticker, if this is a guild sticker.
-   * @returns {Promise<?User>}
-   */
+  
   async fetchUser() {
     if (this.partial) await this.fetch();
     if (!this.guildId) throw new DiscordjsError(ErrorCodes.NotGuildSticker);
     return this.guild.stickers.fetchUser(this);
   }
 
-  /**
-   * Data for editing a sticker.
-   * @typedef {Object} GuildStickerEditOptions
-   * @property {string} [name] The name of the sticker
-   * @property {?string} [description] The description of the sticker
-   * @property {string} [tags] The Discord name of a unicode emoji representing the sticker's expression
-   * @property {string} [reason] Reason for editing this sticker
-   */
+  
 
-  /**
-   * Edits the sticker.
-   * @param {GuildStickerEditOptions} options The options to provide
-   * @returns {Promise<Sticker>}
-   * @example
-   * // Update the name of a sticker
-   * sticker.edit({ name: 'new name' })
-   *   .then(s => console.log(`Updated the name of the sticker to ${s.name}`))
-   *   .catch(console.error);
-   */
+  
   edit(options) {
     return this.guild.stickers.edit(this, options);
   }
 
-  /**
-   * Deletes the sticker.
-   * @returns {Promise<Sticker>}
-   * @param {string} [reason] Reason for deleting this sticker
-   * @example
-   * // Delete a message
-   * sticker.delete()
-   *   .then(s => console.log(`Deleted sticker ${s.name}`))
-   *   .catch(console.error);
-   */
+  
   async delete(reason) {
     await this.guild.stickers.delete(this, reason);
     return this;
   }
 
-  /**
-   * Whether this sticker is the same as another one.
-   * @param {Sticker|APISticker} other The sticker to compare it to
-   * @returns {boolean}
-   */
+  
   equals(other) {
     if (other instanceof Sticker) {
       return (
@@ -266,7 +170,4 @@ class Sticker extends Base {
 
 exports.Sticker = Sticker;
 
-/**
- * @external APISticker
- * @see {@link https://discord.com/developers/docs/resources/sticker#sticker-object}
- */
+

package/src/structures/StickerPack.js

@@ -5,88 +5,48 @@ const { DiscordSnowflake } = require('@sapphire/snowflake');
 const Base = require('./Base');
 const { Sticker } = require('./Sticker');
 
-/**
- * Represents a pack of standard stickers.
- * @extends {Base}
- */
+
 class StickerPack extends Base {
   constructor(client, pack) {
     super(client);
-    /**
-     * The Sticker pack's id
-     * @type {Snowflake}
-     */
+    
     this.id = pack.id;
 
-    /**
-     * The stickers in the pack
-     * @type {Collection<Snowflake, Sticker>}
-     */
+    
     this.stickers = new Collection(pack.stickers.map(s => [s.id, new Sticker(client, s)]));
 
-    /**
-     * The name of the sticker pack
-     * @type {string}
-     */
+    
     this.name = pack.name;
 
-    /**
-     * The id of the pack's SKU
-     * @type {Snowflake}
-     */
+    
     this.skuId = pack.sku_id;
 
-    /**
-     * The id of a sticker in the pack which is shown as the pack's icon
-     * @type {?Snowflake}
-     */
+    
     this.coverStickerId = pack.cover_sticker_id ?? null;
 
-    /**
-     * The description of the sticker pack
-     * @type {string}
-     */
+    
     this.description = pack.description;
 
-    /**
-     * The id of the sticker pack's banner image
-     * @type {?Snowflake}
-     */
+    
     this.bannerId = pack.banner_asset_id ?? null;
   }
 
-  /**
-   * The timestamp the sticker was created at
-   * @type {number}
-   * @readonly
-   */
+  
   get createdTimestamp() {
     return DiscordSnowflake.timestampFrom(this.id);
   }
 
-  /**
-   * The time the sticker was created at
-   * @type {Date}
-   * @readonly
-   */
+  
   get createdAt() {
     return new Date(this.createdTimestamp);
   }
 
-  /**
-   * The sticker which is shown as the pack's icon
-   * @type {?Sticker}
-   * @readonly
-   */
+  
   get coverSticker() {
     return this.coverStickerId && this.stickers.get(this.coverStickerId);
   }
 
-  /**
-   * The URL to this sticker pack's banner.
-   * @param {ImageURLOptions} [options={}] Options for the image URL
-   * @returns {?string}
-   */
+  
   bannerURL(options = {}) {
     return this.bannerId && this.client.rest.cdn.stickerPackBanner(this.bannerId, options);
   }