distube 3.0.6 → 3.2.0

package/dist/DisTube.js

@@ -3,12 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DisTube = void 0;
+exports.DisTube = exports.version = void 0;
 const ytpl_1 = __importDefault(require("@distube/ytpl"));
 const ytsr_1 = __importDefault(require("@distube/ytsr"));
 const util_1 = require("./util");
 const tiny_typed_emitter_1 = require("tiny-typed-emitter");
 const _1 = require(".");
+// TODO: remove deprecated stuff on the next major version
+// Cannot be `import` as it's not under TS root dir
+// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
+exports.version = require("../package.json").version;
 /**
  * DisTube class
  * @extends EventEmitter
@@ -83,70 +87,49 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
          */
         this.customPlugins = this.options.plugins.filter((p) => p.type === "custom");
     }
-    /**
-     * Shorthand method for {@link DisTube#playVoiceChannel}
-     * @returns {Promise<void>}
-     * @param {Discord.Message} message A message from guild channel
-     * @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)
-     * @example
-     * client.on('message', (message) => {
-     *     if (!message.content.startsWith(config.prefix)) return;
-     *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-     *     const command = args.shift();
-     *     if (command == "play")
-     *         distube.play(message, args.join(" "));
-     * });
-     */
-    async play(message, song, options = {}) {
-        if (!song)
-            throw new _1.DisTubeError("INVALID_TYPE", ["string", "Song", "SearchResult", "Playlist"], song, "song");
-        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");
-        }
-        const textChannel = message.channel;
-        const { skip, unshift } = Object.assign({ skip: false, unshift: false }, options);
-        const member = message.member;
-        const voiceChannel = member.voice.channel;
-        if (!voiceChannel)
-            throw new _1.DisTubeError("NOT_IN_VOICE");
-        await this.playVoiceChannel(voiceChannel, song, {
-            member,
-            textChannel,
-            skip,
-            message,
-            unshift,
-        });
+    static get version() {
+        return exports.version;
     }
     /**
-     * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
-     * 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 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 {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)
+     * DisTube version
+     * @type {string}
      */
-    async playVoiceChannel(voiceChannel, song, options = {}) {
-        var _a;
-        if (!(0, _1.isSupportedVoiceChannel)(voiceChannel))
-            throw new _1.DisTubeError("NOT_SUPPORTED_VOICE");
+    get version() {
+        return exports.version;
+    }
+    async play(voiceChannel, song, options = {}) {
+        if ((0, _1.isMessageInstance)(voiceChannel)) {
+            process.emitWarning("Passing Message for DisTube#play is deprecated, use VoiceBasedChannel instead.", "DeprecationWarning");
+            const message = voiceChannel;
+            if (!song)
+                throw new _1.DisTubeError("INVALID_TYPE", ["string", "Song", "SearchResult", "Playlist"], song, "song");
+            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");
+            }
+            const textChannel = message.channel;
+            const { skip, unshift, metadata } = Object.assign({ skip: false, unshift: false }, options);
+            const member = message.member;
+            const vc = member.voice.channel;
+            if (!vc)
+                throw new _1.DisTubeError("NOT_IN_VOICE");
+            return this.play(vc, song, {
+                member,
+                textChannel,
+                skip,
+                message,
+                unshift,
+                metadata,
+            });
+        }
+        if (!(0, _1.isSupportedVoiceChannel)(voiceChannel)) {
+            throw new _1.DisTubeError("INVALID_TYPE", "BaseGuildVoiceChannel", voiceChannel, "voiceChannel");
+        }
         if (typeof options !== "object" || Array.isArray(options)) {
             throw new _1.DisTubeError("INVALID_TYPE", "object", options, "options");
         }
-        const { textChannel, member, skip, message, unshift } = Object.assign({
+        const { textChannel, member, skip, message, unshift, metadata } = Object.assign({
             member: voiceChannel.guild.me,
             skip: false,
             unshift: false,
@@ -158,32 +141,33 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
             if (typeof song === "string") {
                 for (const plugin of this.customPlugins) {
                     if (await plugin.validate(song)) {
-                        return plugin.play(voiceChannel, song, member, textChannel, skip, unshift);
+                        return plugin.play(voiceChannel, song, options);
                     }
                 }
             }
             let queue = this.getQueue(voiceChannel);
-            const queuing = queue && !queue.taskQueue.hasResolveTask;
+            const queuing = !!queue && !queue.taskQueue.hasResolveTask;
             if (queuing)
-                await (queue === null || queue === void 0 ? void 0 : queue.taskQueue.queuing(true));
+                await queue?.taskQueue.queuing(true);
             try {
                 if (song instanceof _1.SearchResult && song.type === "playlist")
                     song = song.url;
-                if (typeof song === "string" && ytpl_1.default.validateID(song))
-                    song = await this.handler.resolvePlaylist(member, song);
+                if (typeof song === "string" && ytpl_1.default.validateID(song)) {
+                    song = await this.handler.resolvePlaylist(song, { member, metadata });
+                }
                 if (typeof song === "string" && !(0, util_1.isURL)(song)) {
                     if (!message)
                         song = (await this.search(song, { limit: 1 }))[0];
                     else
                         song = await this.handler.searchSong(message, song);
                 }
-                song = await this.handler.resolveSong(member, song);
+                song = await this.handler.resolveSong(song, { member, metadata });
                 if (!song)
                     return;
                 if (song instanceof _1.Playlist) {
-                    await this.handler.handlePlaylist(voiceChannel, song, textChannel, skip, unshift);
+                    await this.handler.handlePlaylist(voiceChannel, song, { textChannel, skip, unshift });
                 }
-                else if (!this.options.nsfw && song.age_restricted && !(textChannel === null || textChannel === void 0 ? void 0 : textChannel.nsfw)) {
+                else if (!this.options.nsfw && song.age_restricted && !textChannel?.nsfw) {
                     throw new _1.DisTubeError("NON_NSFW");
                 }
                 else {
@@ -196,7 +180,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
                             this.emit("addSong", queue, song);
                     }
                     else {
-                        const newQueue = await this.handler.createQueue(voiceChannel, song, textChannel);
+                        const newQueue = await this.queues.create(voiceChannel, song, textChannel);
                         if (newQueue instanceof _1.Queue) {
                             if (this.options.emitAddSongWhenCreatingQueue)
                                 this.emit("addSong", newQueue, song);
@@ -207,14 +191,14 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
             }
             finally {
                 if (queuing)
-                    queue === null || queue === void 0 ? void 0 : queue.taskQueue.resolve();
+                    queue?.taskQueue.resolve();
             }
         }
         catch (e) {
             if (!(e instanceof _1.DisTubeError)) {
                 try {
                     e.name = "PlayError";
-                    e.message = `${((_a = song) === null || _a === void 0 ? void 0 : _a.url) || song}\n${e.message}`;
+                    e.message = `${song?.url || song}\n${e.message}`;
                 }
                 catch { }
             }
@@ -222,10 +206,79 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
         }
     }
     /**
-     * <info>Shorthand method of {@link DisTubeHandler#createCustomPlaylist} and {@link DisTube#playVoiceChannel}
+     * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
+     *
+     * @returns {Promise<void>}
+     * @param {Discord.BaseGuildVoiceChannel} voiceChannel The voice channel will be joined
+     * @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 {Discord.GuildMember} [options.member] Requested user (default is your bot)
+     * @param {Discord.BaseGuildTextChannel} [options.textChannel] Default {@link Queue#textChannel}
+     * @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)
+     * @param {*} [options.metadata] Optional metadata that can be attached to the song/playlist will be played,
+     * This is useful for identification purposes when the song/playlist is passed around in events.
+     * See {@link Song#metadata} or {@link Playlist#metadata}
+     * @deprecated Use {@link DisTube#play} instead
+     */
+    async playVoiceChannel(voiceChannel, song, options = {}) {
+        process.emitWarning("DisTube#playVoiceChannel is deprecated, use DisTube#play instead.", "DeprecationWarning");
+        return this.play(voiceChannel, song, options);
+    }
+    /**
+     * Create a custom playlist
+     * @returns {Promise<Playlist>}
+     * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
+     * @param {Object} [options] Optional options
+     * @param {Discord.GuildMember} [options.message] A message from guild channel | A guild member
+     * @param {Object} [options.properties={}] Additional properties such as `name`
+     * @param {boolean} [options.parallel=true] Whether or not fetch the songs in parallel
+     * @param {*} [options.metadata] Metadata
+     * @example
+     * const songs = ["https://www.youtube.com/watch?v=xxx", "https://www.youtube.com/watch?v=yyy"];
+     * const playlist = await distube.createCustomPlaylist(songs, {
+     *     member: message.member,
+     *     properties: { name: "My playlist name" },
+     *     parallel: true
+     * });
+     * distube.play(voiceChannel, playlist, { ... });
+     */
+    async createCustomPlaylist(songs, options = {}) {
+        const { member, properties, parallel, metadata } = Object.assign({ parallel: true }, options);
+        if (!Array.isArray(songs))
+            throw new _1.DisTubeError("INVALID_TYPE", "Array", songs, "songs");
+        if (!songs.length)
+            throw new _1.DisTubeError("EMPTY_ARRAY", "songs");
+        const filteredSongs = songs.filter(song => song instanceof _1.Song || (song instanceof _1.SearchResult && song.type === "video") || (0, util_1.isURL)(song));
+        if (!filteredSongs.length)
+            throw new _1.DisTubeError("NO_VALID_SONG");
+        if (member && !(0, _1.isMemberInstance)(member)) {
+            throw new _1.DisTubeError("INVALID_TYPE", "Discord.Member", member, "options.member");
+        }
+        if (!filteredSongs.length)
+            throw new _1.DisTubeError("NO_VALID_SONG");
+        let resolvedSongs;
+        if (parallel) {
+            const promises = filteredSongs.map((song) => this.handler.resolveSong(song, { member, metadata }).catch(() => undefined));
+            resolvedSongs = (await Promise.all(promises)).filter((s) => !!s);
+        }
+        else {
+            const resolved = [];
+            for (const song of filteredSongs) {
+                resolved.push(await this.handler.resolveSong(song, { member, metadata }).catch(() => undefined));
+            }
+            resolvedSongs = resolved.filter((s) => !!s);
+        }
+        return new _1.Playlist(resolvedSongs, { member, properties, metadata });
+    }
+    /**
+     * <info>Shorthand method of {@link DisTube#createCustomPlaylist} and {@link DisTube#play}
      *
      * If you doesn't have a user message (interaction,...),
-     * see {@link DisTubeHandler#createCustomPlaylist} example</info>
+     * see {@link DisTube#createCustomPlaylist} example</info>
      *
      * Play or add array of video urls.
      * {@link DisTube#event:playSong} or {@link DisTube#event:addList} will be emitted
@@ -234,24 +287,21 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
      * @returns {Promise<void>}
      * @param {Discord.Message} message A message from guild channel
      * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
-     * @param {Object} [properties={}] Additional properties such as `name`
+     * @param {Object} [properties={}] Additional properties for playlist 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.parallel=true] Whether or not fetch the songs in parallel
-     * @example
-     *     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);
+     * @deprecated Use {@link DisTube#createCustomPlaylist} and {@link DisTube#play} instead
      */
     async playCustomPlaylist(message, songs, properties = {}, options = {}) {
+        process.emitWarning("DisTube#playCustomPlaylist is deprecated, use DisTube#createCustomPlaylist and DisTube#play instead.", "DeprecationWarning");
         try {
             if (typeof options !== "object" || Array.isArray(options)) {
                 throw new _1.DisTubeError("INVALID_TYPE", "object", options, "options");
             }
-            const { skip, unshift, parallel } = Object.assign({
+            const { skip, unshift, parallel, metadata } = Object.assign({
                 skip: false,
                 unshift: false,
                 parallel: true,
@@ -259,14 +309,22 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
             const queue = this.getQueue(message);
             const queuing = queue && !queue.taskQueue.hasResolveTask;
             if (queuing)
-                await (queue === null || queue === void 0 ? void 0 : queue.taskQueue.queuing(true));
+                await queue?.taskQueue.queuing(true);
             try {
-                const playlist = await this.handler.createCustomPlaylist(message, songs, properties, parallel);
-                await this.handler.handlePlaylist(message, playlist, message.channel, skip, unshift);
+                const playlist = await this.createCustomPlaylist(songs, {
+                    member: message.member ?? undefined,
+                    properties,
+                    parallel,
+                    metadata,
+                });
+                const voice = message.member?.voice?.channel;
+                if (!voice)
+                    throw new _1.DisTubeError("NOT_IN_VOICE");
+                await this.play(voice, playlist, { textChannel: message.channel, skip, unshift, metadata });
             }
             finally {
                 if (queuing)
-                    queue === null || queue === void 0 ? void 0 : queue.taskQueue.resolve();
+                    queue?.taskQueue.resolve();
             }
         }
         catch (e) {
@@ -274,9 +332,9 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
         }
     }
     /**
-     * Search for a song.
-     * You can customize how user answers instead of send a number.
-     * Then use {@link DisTube#play} or {@link DisTube#playVoiceChannel} to play it.
+     * Search for a song. You can customize how user answers instead of send a number.
+     * Then use {@link DisTube#play} to play it.
+     *
      * @param {string} string The string search for
      * @param {Object} options Search options
      * @param {number} [options.limit=10] Limit the results
@@ -313,7 +371,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Get the guild queue
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Queue?}
      * @throws {Error}
      * @example
@@ -334,7 +392,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Pause the guild stream
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Queue} The guild queue
      * @throws {Error}
      */
@@ -346,7 +404,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Resume the guild stream
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Queue} The guild queue
      * @throws {Error}
      */
@@ -358,7 +416,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Stop the guild stream
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Promise<void>}
      * @throws {Error}
      * @example
@@ -380,7 +438,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Set the guild stream's volume
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @param {number} percent The percentage of volume you want to set
      * @returns {Queue} The guild queue
      * @throws {Error}
@@ -403,7 +461,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
      * 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}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Promise<Song>} The new Song will be played
      * @throws {Error}
      * @example
@@ -423,7 +481,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Play the previous song
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Promise<Song>} The new Song will be played
      * @throws {Error}
      * @example
@@ -443,7 +501,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Shuffle the guild queue songs
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Promise<Queue>} The guild queue
      * @example
      * client.on('message', (message) => {
@@ -464,7 +522,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
      * Jump to the song number in the queue.
      * The next one is 1, 2,...
      * The previous one is -1, -2,...
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @param {number} num The song number to play
      * @returns {Promise<Queue>} The guild queue
      * @throws {Error} if `num` is invalid number (0 < num < {@link Queue#songs}.length)
@@ -487,7 +545,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     /**
      * 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 {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @param {RepeatMode?} [mode] The repeat modes (toggle if `undefined`)
      * @returns {RepeatMode} The new repeat mode
      * @example
@@ -525,7 +583,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Toggle autoplay mode
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {boolean} Autoplay mode state
      * @throws {Error}
      * @example
@@ -548,7 +606,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Add related song to the queue
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @returns {Promise<Song>} The guild queue
      */
     addRelatedSong(queue) {
@@ -560,7 +618,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     /**
      * Enable or disable filter(s) of the queue.
      * Available filters: {@link Filters}
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @param {string|false} filter A filter name, `false` to clear all the filters
      * @param {boolean} [force=false] Force enable the input filter(s) even if it's enabled
      * @returns {Array<string>} Enabled filters.
@@ -583,7 +641,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     }
     /**
      * Set the playing time to another position
-     * @param {GuildIDResolvable} queue The type can be resolved to give a {@link Queue}
+     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
      * @param {number} time Time in seconds
      * @returns {Queue} Seeked queue
      * @example
@@ -605,7 +663,7 @@ class DisTube extends tiny_typed_emitter_1.TypedEmitter {
     /**
      * Emit error event
      * @param {Error} error error
-     * @param {Discord.TextChannel?} channel Text channel where the error is encountered.
+     * @param {Discord.BaseGuildTextChannel} [channel] Text channel where the error is encountered.
      * @private
      */
     emitError(error, channel) {
@@ -662,7 +720,7 @@ exports.default = DisTube;
  * Emitted when DisTube encounters an error.
  *
  * @event DisTube#error
- * @param {Discord.TextChannel} channel Text channel where the error is encountered.
+ * @param {Discord.BaseGuildTextChannel} channel Text channel where the error is encountered.
  * @param {Error} error The error encountered
  * @example
  * distube.on("error", (channel, error) => channel.send(
@@ -723,7 +781,7 @@ exports.default = DisTube;
  */
 /**
  * Emitted when {@link DisTubeOptions|DisTubeOptions.searchSongs} bigger than 0,
- * and song param of {@link DisTube#playVoiceChannel} is invalid url.
+ * and song param of {@link DisTube#play} 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>