distube 3.0.0-beta.35 → 3.0.0-beta.39

package/dist/DisTube.js

@@ -6,17 +6,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DisTube = void 0;
 const ytpl_1 = __importDefault(require("@distube/ytpl"));
 const ytsr_1 = __importDefault(require("@distube/ytsr"));
-const events_1 = require("events");
 const util_1 = require("./util");
+const tiny_typed_emitter_1 = require("tiny-typed-emitter");
 const _1 = require(".");
 /**
  * DisTube class
  * @extends EventEmitter
  */
-class DisTube extends events_1.EventEmitter {
+class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     /**
      * Create a new DisTube class.
-     * @param {Discord.Client} client JS client
+     * @param {Discord.Client} client Discord.JS client
      * @param {DisTubeOptions} [otp] Custom DisTube options
      * @example
      * const Discord = require('discord.js'),
@@ -30,24 +30,24 @@ class DisTube extends events_1.EventEmitter {
     constructor(client, otp = {}) {
         super();
         this.setMaxListeners(1);
-        if (!_1.isClientInstance(client))
+        if (!(0, _1.isClientInstance)(client))
             throw new _1.DisTubeError("INVALID_TYPE", "Discord.Client", client, "client");
         /**
          * Discord.JS client
          * @type {Discord.Client}
          */
         this.client = client;
-        util_1.checkIntents(client.options);
-        /**
-         * Voice connections manager
-         * @type {DisTubeVoiceManager}
-         */
-        this.voices = new _1.DisTubeVoiceManager(this);
+        (0, util_1.checkIntents)(client.options);
         /**
          * DisTube options
          * @type {DisTubeOptions}
          */
         this.options = new _1.Options(otp);
+        /**
+         * Voice connections manager
+         * @type {DisTubeVoiceManager}
+         */
+        this.voices = new _1.DisTubeVoiceManager(this);
         /**
          * DisTube's Handler
          * @type {DisTubeHandler}
@@ -64,38 +64,7 @@ class DisTube extends events_1.EventEmitter {
          * @type {Filters}
          */
         this.filters = _1.defaultFilters;
-        if (typeof this.options.customFilters === "object")
-            Object.assign(this.filters, this.options.customFilters);
-        if (this.options.leaveOnEmpty) {
-            client.on("voiceStateUpdate", oldState => {
-                if (!(oldState === null || oldState === void 0 ? void 0 : oldState.channel))
-                    return;
-                const queue = this.getQueue(oldState);
-                if (!queue) {
-                    if (util_1.isVoiceChannelEmpty(oldState)) {
-                        setTimeout(() => {
-                            const guildID = oldState.guild.id;
-                            if (!this.getQueue(oldState) && util_1.isVoiceChannelEmpty(oldState))
-                                this.voices.leave(guildID);
-                        }, this.options.emptyCooldown * 1e3).unref();
-                    }
-                    return;
-                }
-                if (queue.emptyTimeout) {
-                    clearTimeout(queue.emptyTimeout);
-                    delete queue.emptyTimeout;
-                }
-                if (util_1.isVoiceChannelEmpty(oldState)) {
-                    queue.emptyTimeout = setTimeout(() => {
-                        if (util_1.isVoiceChannelEmpty(oldState)) {
-                            queue.voice.leave();
-                            this.emit("empty", queue);
-                            queue.delete();
-                        }
-                    }, this.options.emptyCooldown * 1e3).unref();
-                }
-            });
-        }
+        Object.assign(this.filters, this.options.customFilters);
         // Default plugin
         this.options.plugins.push(new _1.HTTPPlugin(), new _1.HTTPSPlugin());
         if (this.options.youtubeDL)
@@ -118,10 +87,12 @@ class DisTube extends events_1.EventEmitter {
      * Shorthand method for {@link DisTube#playVoiceChannel}
      * @returns {Promise<void>}
      * @param {Discord.Message} message A message from guild channel
-     * @param {string|Song|SearchResult|Playlist} song YouTube url | Search string | {@link Song} | {@link SearchResult} | {@link Playlist}
+     * @param {string|Song|SearchResult|Playlist} song URL | Search string |
+     * {@link Song} | {@link SearchResult} | {@link Playlist}
      * @param {Object} [options] Optional options
      * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
-     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue (after the playing song if exists)
+     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
+     * (after the playing song if exists)
      * @example
      * client.on('message', (message) => {
      *     if (!message.content.startsWith(config.prefix)) return;
@@ -134,7 +105,7 @@ class DisTube extends events_1.EventEmitter {
     async play(message, song, options = {}) {
         if (!song)
             return;
-        if (!_1.isMessageInstance(message))
+        if (!(0, _1.isMessageInstance)(message))
             throw new _1.DisTubeError("INVALID_TYPE", "Discord.Message", message, "message");
         if (typeof options !== "object" || Array.isArray(options)) {
             throw new _1.DisTubeError("INVALID_TYPE", "object", options, "options");
@@ -158,17 +129,19 @@ class DisTube extends events_1.EventEmitter {
      * Emit {@link DisTube#addList}, {@link DisTube#addSong} or {@link DisTube#playSong} after executing
      * @returns {Promise<void>}
      * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined
-     * @param {string|Song|SearchResult|Playlist} song YouTube url | Search string | {@link Song} | {@link SearchResult} | {@link Playlist}
+     * @param {string|Song|SearchResult|Playlist} song URL | Search string |
+     * {@link Song} | {@link SearchResult} | {@link Playlist}
      * @param {Object} [options] Optional options
      * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
-     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue (after the playing song if exists)
+     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
+     * (after the playing song if exists)
      * @param {Discord.GuildMember} [options.member] Requested user (default is your bot)
      * @param {Discord.TextChannel} [options.textChannel] Default {@link Queue#textChannel} (if the queue wasn't created)
      * @param {Discord.Message} [options.message] Called message (For built-in search events. If this is a {@link https://developer.mozilla.org/en-US/docs/Glossary/Falsy|falsy value}, it will play the first result instead)
      */
     async playVoiceChannel(voiceChannel, song, options = {}) {
         var _a;
-        if (!_1.isSupportedVoiceChannel(voiceChannel))
+        if (!(0, _1.isSupportedVoiceChannel)(voiceChannel))
             throw new _1.DisTubeError("NOT_SUPPORTED_VOICE");
         if (typeof options !== "object" || Array.isArray(options)) {
             throw new _1.DisTubeError("INVALID_TYPE", "object", options, "options");
@@ -178,7 +151,7 @@ class DisTube extends events_1.EventEmitter {
             skip: false,
             unshift: false,
         }, options);
-        if (message && !_1.isMessageInstance(message)) {
+        if (message && !(0, _1.isMessageInstance)(message)) {
             throw new _1.DisTubeError("INVALID_TYPE", ["Discord.Message", "a falsy value"], message, "options.message");
         }
         try {
@@ -198,7 +171,7 @@ class DisTube extends events_1.EventEmitter {
                     song = song.url;
                 if (typeof song === "string" && ytpl_1.default.validateID(song))
                     song = await this.handler.resolvePlaylist(member, song);
-                if (typeof song === "string" && !util_1.isURL(song)) {
+                if (typeof song === "string" && !(0, util_1.isURL)(song)) {
                     if (!message)
                         song = (await this.search(song, { limit: 1 }))[0];
                     else
@@ -249,6 +222,11 @@ class DisTube extends events_1.EventEmitter {
         }
     }
     /**
+     * <info>Shorthand method of {@link DisTubeHandler#createCustomPlaylist} and {@link DisTube#playVoiceChannel}
+     *
+     * If you doesn't have a user message (interaction,...),
+     * see {@link DisTubeHandler#createCustomPlaylist} example</info>
+     *
      * Play or add array of video urls.
      * {@link DisTube#event:playSong} or {@link DisTube#event:addList} will be emitted
      * with `playlist`'s properties include `properties` parameter's properties such as
@@ -259,10 +237,11 @@ class DisTube extends events_1.EventEmitter {
      * @param {Object} [properties={}] Additional properties such as `name`
      * @param {Object} [options] Optional options
      * @param {boolean} [options.skip=false] Skip the playing song (if exists) and play the added song/playlist instantly
-     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue (after the playing song if exists)
+     * @param {boolean} [options.unshift=false] Add the song/playlist to the beginning of the queue
+     * (after the playing song if exists)
      * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
      * @example
-     *     let songs = ["https://www.youtube.com/watch?v=xxx", "https://www.youtube.com/watch?v=yyy"];
+     *     const songs = ["https://www.youtube.com/watch?v=xxx", "https://www.youtube.com/watch?v=yyy"];
      *     distube.playCustomPlaylist(message, songs, { name: "My playlist name" });
      *     // Fetching custom playlist sequentially (reduce lag for low specs)
      *     distube.playCustomPlaylist(message, songs, { name: "My playlist name" }, false, false);
@@ -297,7 +276,7 @@ class DisTube extends events_1.EventEmitter {
     /**
      * Search for a song.
      * You can customize how user answers instead of send a number.
-     * Then use {@link DisTube#play} or {@link DisTube#playSkip} to play it.
+     * Then use {@link DisTube#play} or {@link DisTube#playVoiceChannel} to play it.
      * @param {string} string The string search for
      * @param {Object} options Search options
      * @param {number} [options.limit=10] Limit the results
@@ -319,7 +298,7 @@ class DisTube extends events_1.EventEmitter {
             throw new _1.DisTubeError("INVALID_TYPE", "boolean", opts.safeSearch, "options.safeSearch");
         }
         try {
-            const search = await ytsr_1.default(string, opts);
+            const search = await (0, ytsr_1.default)(string, opts);
             const results = search.items.map(i => new _1.SearchResult(i));
             if (results.length === 0)
                 throw new _1.DisTubeError("NO_RESULT");
@@ -421,7 +400,9 @@ class DisTube extends events_1.EventEmitter {
         return q.setVolume(percent);
     }
     /**
-     * Skip the playing song
+     * Skip the playing song if there is a next song in the queue.
+     * <info>If {@link Queue#autoplay} is `true` and there is no up next song,
+     * DisTube will add and play a related song.</info>
      * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Promise<Song>} The new Song will be played
      * @throws {Error}
@@ -504,12 +485,11 @@ class DisTube extends events_1.EventEmitter {
         return q.jump(num);
     }
     /**
-     * Set the repeat mode of the guild queue.
-     * Turn off if repeat mode is the same value as new mode.
-     * Toggle mode `(0 -> 1 -> 2 -> 0...)`: `mode` is `undefined`
+     * Set the repeat mode of the guild queue.\
+     * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
      * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
-     * @param {number?} [mode] The repeat modes `(0: disabled, 1: Repeat a song, 2: Repeat all the queue)`
-     * @returns {number} The new repeat mode
+     * @param {RepeatMode?} [mode] The repeat modes (toggle if `undefined`)
+     * @returns {RepeatMode} The new repeat mode
      * @example
      * client.on('message', (message) => {
      *     if (!message.content.startsWith(config.prefix)) return;
@@ -521,6 +501,21 @@ class DisTube extends events_1.EventEmitter {
      *         message.channel.send("Set repeat mode to `" + mode + "`");
      *     }
      * });
+     * @example
+     * const { RepeatMode } = require("distube");
+     * let mode;
+     * switch(distube.setRepeatMode(message, parseInt(args[0]))) {
+     *     case RepeatMode.DISABLED:
+     *         mode = "Off";
+     *         break;
+     *     case RepeatMode.SONG:
+     *         mode = "Repeat a song";
+     *         break;
+     *     case RepeatMode.QUEUE:
+     *         mode = "Repeat all queue";
+     *         break;
+     * }
+     * message.channel.send("Set repeat mode to `" + mode + "`");
      */
     setRepeatMode(queue, mode) {
         const q = this.getQueue(queue);
@@ -539,7 +534,7 @@ class DisTube extends events_1.EventEmitter {
      *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
      *     const command = args.shift();
      *     if (command == "autoplay") {
-     *         let mode = distube.toggleAutoplay(message);
+     *         const mode = distube.toggleAutoplay(message);
      *         message.channel.send("Set autoplay mode to `" + (mode ? "On" : "Off") + "`");
      *     }
      * });
@@ -575,7 +570,7 @@ class DisTube extends events_1.EventEmitter {
      *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
      *     const command = args.shift();
      *     if ([`3d`, `bassboost`, `echo`, `karaoke`, `nightcore`, `vaporwave`].includes(command)) {
-     *         let filter = distube.setFilter(message, command);
+     *         const filter = distube.setFilter(message, command);
      *         message.channel.send("Current queue filter: " + (filter.join(", ") || "Off"));
      *     }
      * });
@@ -614,7 +609,7 @@ class DisTube extends events_1.EventEmitter {
      * @private
      */
     emitError(error, channel) {
-        if (!channel || !_1.isTextChannelInstance(channel)) {
+        if (!channel || !(0, _1.isTextChannelInstance)(channel)) {
             console.error(error);
             console.warn("This is logged because <Queue>.textChannel is undefined");
         }
@@ -631,7 +626,7 @@ class DisTube extends events_1.EventEmitter {
 exports.DisTube = DisTube;
 exports.default = DisTube;
 /**
- * Emitted after DisTube add a new playlist to the playing {@link Queue}
+ * Emitted after DisTube add a new playlist to the playing {@link Queue}.
  *
  * @event DisTube#addList
  * @param {Queue} queue The guild queue
@@ -642,7 +637,7 @@ exports.default = DisTube;
  * ));
  */
 /**
- *  Emitted after DisTube add a new song to the playing {@link Queue}
+ * Emitted after DisTube add a new song to the playing {@link Queue}.
  *
  * @event DisTube#addSong
  * @param {Queue} queue The guild queue
@@ -653,16 +648,18 @@ exports.default = DisTube;
  * ));
  */
 /**
- * Emitted when there is no user in the voice channel, {@link DisTubeOptions}.leaveOnEmpty is `true` and there is a playing queue.
- * If there is no playing queue (stopped and {@link DisTubeOptions}.leaveOnStop is `false`), it will leave the channel without emitting this event.
+ * Emitted when there is no user in the voice channel,
+ * {@link DisTubeOptions}.leaveOnEmpty is `true` and there is a playing queue.
  *
+ * If there is no playing queue (stopped and {@link DisTubeOptions}.leaveOnStop is `false`),
+ * it will leave the channel without emitting this event.
  * @event DisTube#empty
  * @param {Queue} queue The guild queue
  * @example
  * distube.on("empty", queue => queue.textChannel.send("Channel is empty. Leaving the channel"))
  */
 /**
- * Emitted when {@link DisTube} encounters an error.
+ * Emitted when DisTube encounters an error.
  *
  * @event DisTube#error
  * @param {Discord.TextChannel} channel Text channel where the error is encountered.
@@ -674,7 +671,7 @@ exports.default = DisTube;
  */
 /**
  * Emitted when there is no more song in the queue and {@link Queue#autoplay} is `false`.
- * DisTube will leave voice channel if {@link DisTubeOptions}.leaveOnFinish is `true`
+ * DisTube will leave voice channel if {@link DisTubeOptions}.leaveOnFinish is `true`.
  *
  * @event DisTube#finish
  * @param {Queue} queue The guild queue
@@ -693,8 +690,8 @@ exports.default = DisTube;
  * });
  */
 /**
- * Emitted when {@link Queue#autoplay} is `true`, the {@link Queue#songs} is empty and
- * DisTube cannot find related songs to play
+ * Emitted when {@link Queue#autoplay} is `true`, {@link Queue#songs} is empty,
+ * and DisTube cannot find related songs to play.
  *
  * @event DisTube#noRelated
  * @param {Queue} queue The guild queue
@@ -703,19 +700,20 @@ exports.default = DisTube;
  */
 /**
  * Emitted when DisTube play a song.
- * If {@link DisTubeOptions}.emitNewSongOnly is `true`, event is not emitted when looping a song or next song is the previous one
+ *
+ * If {@link DisTubeOptions}.emitNewSongOnly is `true`,
+ * this event is not emitted when looping a song or next song is the previous one.
  *
  * @event DisTube#playSong
  * @param {Queue} queue The guild queue
  * @param {Song} song Playing song
  * @example
- * const status = (queue) => `Volume: \`${queue.volume}%\` | Loop: \`${queue.repeatMode ? queue.repeatMode == 2 ? "Server Queue" : "This Song" : "Off"}\` | Autoplay: \`${queue.autoplay ? "On" : "Off"}\``;
  * distube.on("playSong", (queue, song) => queue.textChannel.send(
- *     `Playing \`${song.name}\` - \`${song.formattedDuration}\`\nRequested by: ${song.user}\n${status(queue)}`
+ *     `Playing \`${song.name}\` - \`${song.formattedDuration}\`\nRequested by: ${song.user}`
  * ));
  */
 /**
- * Emitted when DisTube cannot find any results for the query
+ * Emitted when DisTube cannot find any results for the query.
  *
  * @event DisTube#searchNoResult
  * @param {Discord.Message} message The user message called play method
@@ -724,9 +722,9 @@ exports.default = DisTube;
  * distube.on("searchNoResult", (message, query) => message.channel.send(`No result found for ${query}!`));
  */
 /**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and song param of {@link DisTube#play|play()} is invalid url.
- * DisTube will wait for user's next message to choose song manually.
+ * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0,
+ * and song param of {@link DisTube#playVoiceChannel} is invalid url.
+ * DisTube will wait for user's next message to choose a song manually.
  * <info>{@link https://support.google.com/youtube/answer/7354993|Safe search} is enabled
  * if {@link DisTubeOptions}.nsfw is disabled and the message's channel is not a nsfw channel.</info>
  *
@@ -737,12 +735,14 @@ exports.default = DisTube;
  * @example
  * // DisTubeOptions.searchSongs > 0
  * distube.on("searchResult", (message, results) => {
- *     message.channel.send(`**Choose an option from below**\n${results.map((song, i) => `**${i + 1}**. ${song.name} - \`${song.formattedDuration}\``).join("\n")}\n*Enter anything else or wait 60 seconds to cancel*`);
+ *     message.channel.send(`**Choose an option from below**\n${
+ *         results.map((song, i) => `**${i + 1}**. ${song.name} - \`${song.formattedDuration}\``).join("\n")
+ *     }\n*Enter anything else or wait 60 seconds to cancel*`);
  * });
  */
 /**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and the search canceled due to {@link DisTubeOptions|DisTubeOptions.searchTimeout}
+ * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0,
+ * and the search canceled due to {@link DisTubeOptions|DisTubeOptions.searchTimeout}.
  *
  * @event DisTube#searchCancel
  * @param {Discord.Message} message The user message called play method
@@ -752,8 +752,8 @@ exports.default = DisTube;
  * distube.on("searchCancel", (message) => message.channel.send(`Searching canceled`));
  */
 /**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and the search canceled due to user's next message is not a number or out of results range
+ * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0,
+ * and the search canceled due to user's next message is not a number or out of results range.
  *
  * @event DisTube#searchInvalidAnswer
  * @param {Discord.Message} message The user message called play method
@@ -764,8 +764,8 @@ exports.default = DisTube;
  * distube.on("searchInvalidAnswer", (message) => message.channel.send(`You answered an invalid number!`));
  */
 /**
- * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0
- * and after the user chose a search result to play
+ * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0,
+ * and after the user chose a search result to play.
  *
  * @event DisTube#searchDone
  * @param {Discord.Message} message The user message called play method
@@ -773,7 +773,7 @@ exports.default = DisTube;
  * @param {string} query The search query
  */
 /**
- * Emitted when the bot is disconnected to the voice channel
+ * Emitted when the bot is disconnected to a voice channel.
  *
  * @event DisTube#disconnect
  * @param {Queue} queue The guild queue
@@ -785,7 +785,7 @@ exports.default = DisTube;
  * @param {Queue} queue The guild queue
  */
 /**
- * Emitted when DisTube finished a song
+ * Emitted when DisTube finished a song.
  *
  * @event DisTube#finishSong
  * @param {Queue} queue The guild queue