@velliajs/discord 1.0.2 → 1.0.4

package/src/structures/VoiceChannel.js

@@ -3,31 +3,20 @@
 const { PermissionFlagsBits } = require('discord-api-types/v10');
 const BaseGuildVoiceChannel = require('./BaseGuildVoiceChannel');
 
-/**
- * Represents a guild voice channel on Discord.
- * @extends {BaseGuildVoiceChannel}
- */
+
 class VoiceChannel extends BaseGuildVoiceChannel {
-  /**
-   * Whether the channel is joinable by the client user
-   * @type {boolean}
-   * @readonly
-   */
+  
   get joinable() {
     if (!super.joinable) return false;
     if (this.full && !this.permissionsFor(this.client.user).has(PermissionFlagsBits.MoveMembers, false)) return false;
     return true;
   }
 
-  /**
-   * Checks if the client has permission to send audio to the voice channel
-   * @type {boolean}
-   * @readonly
-   */
+  
   get speakable() {
     const permissions = this.permissionsFor(this.client.user);
     if (!permissions) return false;
-    // This flag allows speaking even if timed out
+    
     if (permissions.has(PermissionFlagsBits.Administrator, false)) return true;
 
     return (
@@ -37,60 +26,12 @@ class VoiceChannel extends BaseGuildVoiceChannel {
   }
 }
 
-/**
- * Sets the bitrate of the channel.
- * @method setBitrate
- * @memberof VoiceChannel
- * @instance
- * @param {number} bitrate The new bitrate
- * @param {string} [reason] Reason for changing the channel's bitrate
- * @returns {Promise<VoiceChannel>}
- * @example
- * // Set the bitrate of a voice channel
- * voiceChannel.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 VoiceChannel
- * @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<VoiceChannel>}
- * @example
- * // Set the RTC region to sydney
- * voiceChannel.setRTCRegion('sydney');
- * @example
- * // Remove a fixed region for this channel - let Discord decide automatically
- * voiceChannel.setRTCRegion(null, 'We want to let Discord decide.');
- */
 
-/**
- * Sets the user limit of the channel.
- * @method setUserLimit
- * @memberof VoiceChannel
- * @instance
- * @param {number} userLimit The new user limit
- * @param {string} [reason] Reason for changing the user limit
- * @returns {Promise<VoiceChannel>}
- * @example
- * // Set the user limit of a voice channel
- * voiceChannel.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 VoiceChannel
- * @instance
- * @param {VideoQualityMode} videoQualityMode The new camera video quality mode.
- * @param {string} [reason] Reason for changing the camera video quality mode.
- * @returns {Promise<VoiceChannel>}
- */
+
+
+
+
 
 module.exports = VoiceChannel;

package/src/structures/VoiceRegion.js

@@ -2,39 +2,22 @@
 
 const { flatten } = require('../util/Util');
 
-/**
- * Represents a Discord voice region for guilds.
- */
+
 class VoiceRegion {
   constructor(data) {
-    /**
-     * The region's id
-     * @type {string}
-     */
+    
     this.id = data.id;
 
-    /**
-     * Name of the region
-     * @type {string}
-     */
+    
     this.name = data.name;
 
-    /**
-     * Whether the region is deprecated
-     * @type {boolean}
-     */
+    
     this.deprecated = data.deprecated;
 
-    /**
-     * Whether the region is optimal
-     * @type {boolean}
-     */
+    
     this.optimal = data.optimal;
 
-    /**
-     * Whether the region is custom
-     * @type {boolean}
-     */
+    
     this.custom = data.custom;
   }
 

package/src/structures/VoiceState.js

@@ -4,124 +4,85 @@ const { ChannelType, Routes } = require('discord-api-types/v10');
 const Base = require('./Base');
 const { DiscordjsError, DiscordjsTypeError, ErrorCodes } = require('../errors');
 
-/**
- * Represents the voice state for a Guild Member.
- * @extends {Base}
- */
+
 class VoiceState extends Base {
   constructor(guild, data) {
     super(guild.client);
-    /**
-     * The guild of this voice state
-     * @type {Guild}
-     */
+    
     this.guild = guild;
-    /**
-     * The id of the member of this voice state
-     * @type {Snowflake}
-     */
+    
     this.id = data.user_id;
     this._patch(data);
   }
 
   _patch(data) {
     if ('deaf' in data) {
-      /**
-       * Whether this member is deafened server-wide
-       * @type {?boolean}
-       */
+      
       this.serverDeaf = data.deaf;
     } else {
       this.serverDeaf ??= null;
     }
 
     if ('mute' in data) {
-      /**
-       * Whether this member is muted server-wide
-       * @type {?boolean}
-       */
+      
       this.serverMute = data.mute;
     } else {
       this.serverMute ??= null;
     }
 
     if ('self_deaf' in data) {
-      /**
-       * Whether this member is self-deafened
-       * @type {?boolean}
-       */
+      
       this.selfDeaf = data.self_deaf;
     } else {
       this.selfDeaf ??= null;
     }
 
     if ('self_mute' in data) {
-      /**
-       * Whether this member is self-muted
-       * @type {?boolean}
-       */
+      
       this.selfMute = data.self_mute;
     } else {
       this.selfMute ??= null;
     }
 
     if ('self_video' in data) {
-      /**
-       * Whether this member's camera is enabled
-       * @type {?boolean}
-       */
+      
       this.selfVideo = data.self_video;
     } else {
       this.selfVideo ??= null;
     }
 
     if ('session_id' in data) {
-      /**
-       * The session id for this member's connection
-       * @type {?string}
-       */
+      
       this.sessionId = data.session_id;
     } else {
       this.sessionId ??= null;
     }
 
-    // The self_stream is property is omitted if false, check for another property
-    // here to avoid incorrectly clearing this when partial data is specified
+    
+    
     if ('self_video' in data) {
-      /**
-       * Whether this member is streaming using "Screen Share"
-       * @type {?boolean}
-       */
+      
       this.streaming = data.self_stream ?? false;
     } else {
       this.streaming ??= null;
     }
 
     if ('channel_id' in data) {
-      /**
-       * The {@link VoiceChannel} or {@link StageChannel} id the member is in
-       * @type {?Snowflake}
-       */
+      
       this.channelId = data.channel_id;
     } else {
       this.channelId ??= null;
     }
 
     if ('suppress' in data) {
-      /**
-       * Whether this member is suppressed from speaking. This property is specific to stage channels only.
-       * @type {?boolean}
-       */
+      
       this.suppress = data.suppress;
     } else {
       this.suppress ??= null;
     }
 
     if ('request_to_speak_timestamp' in data) {
-      /**
-       * The time at which the member requested to speak. This property is specific to stage channels only.
-       * @type {?number}
-       */
+      
       this.requestToSpeakTimestamp = data.request_to_speak_timestamp && Date.parse(data.request_to_speak_timestamp);
     } else {
       this.requestToSpeakTimestamp ??= null;
@@ -130,95 +91,49 @@ class VoiceState extends Base {
     return this;
   }
 
-  /**
-   * The member that this voice state belongs to
-   * @type {?GuildMember}
-   * @readonly
-   */
+  
   get member() {
     return this.guild.members.cache.get(this.id) ?? null;
   }
 
-  /**
-   * The channel that the member is connected to
-   * @type {?(VoiceChannel|StageChannel)}
-   * @readonly
-   */
+  
   get channel() {
     return this.guild.channels.cache.get(this.channelId) ?? null;
   }
 
-  /**
-   * Whether this member is either self-deafened or server-deafened
-   * @type {?boolean}
-   * @readonly
-   */
+  
   get deaf() {
     return this.serverDeaf || this.selfDeaf;
   }
 
-  /**
-   * Whether this member is either self-muted or server-muted
-   * @type {?boolean}
-   * @readonly
-   */
+  
   get mute() {
     return this.serverMute || this.selfMute;
   }
 
-  /**
-   * Mutes/unmutes the member of this voice state.
-   * @param {boolean} [mute=true] Whether or not the member should be muted
-   * @param {string} [reason] Reason for muting or unmuting
-   * @returns {Promise<GuildMember>}
-   */
+  
   setMute(mute = true, reason) {
     return this.guild.members.edit(this.id, { mute, reason });
   }
 
-  /**
-   * Deafens/undeafens the member of this voice state.
-   * @param {boolean} [deaf=true] Whether or not the member should be deafened
-   * @param {string} [reason] Reason for deafening or undeafening
-   * @returns {Promise<GuildMember>}
-   */
+  
   setDeaf(deaf = true, reason) {
     return this.guild.members.edit(this.id, { deaf, reason });
   }
 
-  /**
-   * Disconnects the member from the channel.
-   * @param {string} [reason] Reason for disconnecting the member from the channel
-   * @returns {Promise<GuildMember>}
-   */
+  
   disconnect(reason) {
     return this.setChannel(null, reason);
   }
 
-  /**
-   * Moves the member to a different channel, or disconnects them from the one they're in.
-   * @param {GuildVoiceChannelResolvable|null} channel Channel to move the member to, or `null` if you want to
-   * disconnect them from voice.
-   * @param {string} [reason] Reason for moving member to another channel or disconnecting
-   * @returns {Promise<GuildMember>}
-   */
+  
   setChannel(channel, reason) {
     return this.guild.members.edit(this.id, { channel, reason });
   }
 
-  /**
-   * Data to edit the logged in user's own voice state with, when in a stage channel
-   * @typedef {Object} VoiceStateEditOptions
-   * @property {boolean} [requestToSpeak] Whether or not the client is requesting to become a speaker.
-   * <info>Only available to the logged in user's own voice state.</info>
-   * @property {boolean} [suppressed] Whether or not the user should be suppressed.
-   */
-
-  /**
-   * Edits this voice state. Currently only available when in a stage channel
-   * @param {VoiceStateEditOptions} options The options to provide
-   * @returns {Promise<VoiceState>}
-   */
+  
+
+  
   async edit(options) {
     if (this.channel?.type !== ChannelType.GuildStageVoice) throw new DiscordjsError(ErrorCodes.VoiceNotStageChannel);
 
@@ -250,39 +165,12 @@ class VoiceState extends Base {
     return this;
   }
 
-  /**
-   * Toggles the request to speak in the channel.
-   * Only applicable for stage channels and for the client's own voice state.
-   * @param {boolean} [requestToSpeak=true] Whether or not the client is requesting to become a speaker.
-   * @example
-   * // Making the client request to speak in a stage channel (raise its hand)
-   * guild.members.me.voice.setRequestToSpeak(true);
-   * @example
-   * // Making the client cancel a request to speak
-   * guild.members.me.voice.setRequestToSpeak(false);
-   * @returns {Promise<VoiceState>}
-   */
+  
   setRequestToSpeak(requestToSpeak = true) {
     return this.edit({ requestToSpeak });
   }
 
-  /**
-   * Suppress/unsuppress the user. Only applicable for stage channels.
-   * @param {boolean} [suppressed=true] Whether or not the user should be suppressed.
-   * @example
-   * // Making the client a speaker
-   * guild.members.me.voice.setSuppressed(false);
-   * @example
-   * // Making the client an audience member
-   * guild.members.me.voice.setSuppressed(true);
-   * @example
-   * // Inviting another user to speak
-   * voiceState.setSuppressed(false);
-   * @example
-   * // Moving another user to the audience, or cancelling their invite to speak
-   * voiceState.setSuppressed(true);
-   * @returns {Promise<VoiceState>}
-   */
+  
   setSuppressed(suppressed = true) {
     return this.edit({ suppressed });
   }