distube 3.3.1 → 4.0.0-dev.2

package/README.md

@@ -7,7 +7,7 @@
     <img alt="node-current" src="https://img.shields.io/node/v/distube?logo=node.js&logoColor=white&style=flat-square">
     <img alt="npm peer dependency version" src="https://img.shields.io/npm/dependency-version/distube/peer/discord.js?label=discord.js&logo=discord&logoColor=white&style=flat-square">
     <img alt="Depfu" src="https://img.shields.io/depfu/skick1234/DisTube?style=flat-square">
-    <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW">
+    <img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/skick1234/DisTube/main?logo=codecov&logoColor=white&style=flat-square&token=WWDYRRSEQW">
     <br>
     <img alt="npm" src="https://img.shields.io/npm/dt/distube?logo=npm&style=flat-square">
     <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/skick1234/DisTube?logo=github&logoColor=white&style=flat-square">
@@ -25,25 +25,24 @@ A Discord.js module to simplify your music commands and play songs with audio fi
 
 - Build on `@discordjs/voice`
 - Easy to use and customize
-- Support YouTube, SoundCloud, Facebook, and [700+ more sites](https://ytdl-org.github.io/youtube-dl/supportedsites.html)
+- Support YouTube and audio link
 - Audio filters (bassboost, nightcore, vaporwave,...)
 - Autoplay related songs
 - Plugin system to support more sites ([Plugin List](https://distube.js.org/#/docs/DisTube/stable/plugin/list))
 
-### Requirement
+## Requirement
 
-- Node v12 or higher
-- [discord.js](https://discord.js.org) v12 or **v13 _(Recommended)_**
+- Node.js 16.9.0 or higher
+- [discord.js](https://discord.js.org) v14
 - [@discordjs/voice](https://github.com/discordjs/voice)
 - [FFmpeg](https://www.ffmpeg.org/download.html)
 - [@discordjs/opus](https://github.com/discordjs/opus)
 - [sodium](https://www.npmjs.com/package/sodium) or [libsodium-wrappers](https://www.npmjs.com/package/libsodium-wrappers)
-- [python](https://www.python.org/) _(Optional - For [`youtube-dl`](https://youtube-dl.org/) to support [700+ more sites](https://ytdl-org.github.io/youtube-dl/supportedsites.html).)_
 
 ## Installation
 
 ```npm
-npm install distube@latest
+npm install distube@dev
 ```
 
 ## Documentation
@@ -61,4 +60,3 @@ Read DisTube's definitions, properties and events details in the [Documentation
 - [node-ytdl-core](https://github.com/fent/node-ytdl-core): YouTube scraper ([DisTube Fork](https://github.com/distubejs/node-ytdl-core))
 - [node-ytsr](https://github.com/TimeForANinja/node-ytsr): YouTube search scraper ([DisTube Fork](https://github.com/distubejs/ytsr))
 - [node-ytpl](https://github.com/TimeForANinja/node-ytpl): YouTube playlist resolver ([DisTube Fork](https://github.com/distubejs/ytpl))
-- [youtube-dl-exec](https://github.com/microlinkhq/youtube-dl-exec): [`youtube-dl`](https://youtube-dl.org/) wrapper

package/dist/DisTube.d.ts

@@ -3,10 +3,6 @@ import { DisTubeHandler, DisTubeVoiceManager, Options, Playlist, Queue, QueueMan
 import type { Client, GuildMember, GuildTextBasedChannel, Message, VoiceBasedChannel } from "discord.js";
 import type { CustomPlugin, DisTubeEvents, DisTubeOptions, ExtractorPlugin, Filters, GuildIdResolvable } from ".";
 export declare const version: string;
-/**
- * DisTube class
- * @extends EventEmitter
- */
 export declare class DisTube extends TypedEmitter<DisTubeEvents> {
     readonly handler: DisTubeHandler;
     readonly options: Options;
@@ -16,60 +12,9 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
     readonly extractorPlugins: ExtractorPlugin[];
     readonly customPlugins: CustomPlugin[];
     readonly filters: Filters;
-    /**
-     * Create a new DisTube class.
-     * @param {Discord.Client} client Discord.JS client
-     * @param {DisTubeOptions} [otp] Custom DisTube options
-     * @example
-     * const Discord = require('discord.js'),
-     *     DisTube = require('distube'),
-     *     client = new Discord.Client();
-     * // Create a new DisTube
-     * const distube = new DisTube.default(client, { searchSongs: 10 });
-     * // client.DisTube = distube // make it access easily
-     * client.login("Your Discord Bot Token")
-     */
     constructor(client: Client, otp?: DisTubeOptions);
     static get version(): string;
-    /**
-     * DisTube version
-     * @type {string}
-     */
     get version(): string;
-    /**
-     * Play / add a song or playlist from url. Search and play a song if it is not a valid url.
-     *
-     * @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 if `position` is 1.
-     * If `position` is defined and not equal to 1, it will skip to the next song instead of the added song
-     * @param {number} [options.position=0] Position of the song/playlist to add to the queue,
-     * <= 0 to add to the end of the queue.
-     * @param {boolean} [options.unshift=false] (DEPRECATED) 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}
-     * @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.member.voice?.channel, args.join(" "), {
-     *             member: message.member,
-     *             textChannel: message.channel,
-     *             message
-     *         });
-     * });
-     * @returns {Promise<void>}
-     */
     play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist, options?: {
         skip?: boolean;
         position?: number;
@@ -78,521 +23,32 @@ export declare class DisTube extends TypedEmitter<DisTubeEvents> {
         message?: Message;
         metadata?: any;
     }): Promise<void>;
-    /** @deprecated Message parameter is deprecated, use VoiceChannel instead. */
-    play(message: Message<true>, song: string | Song | SearchResult | Playlist, options?: {
-        skip?: boolean;
-        unshift?: boolean;
-        metadata?: any;
-    }): Promise<void>;
-    /** @deprecated `options.unshift` is deprecated, use `options.position` instead */
-    play(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist, options?: {
-        skip?: boolean;
-        /** @deprecated Use `options.position` instead */
-        unshift?: boolean;
-        position?: number;
-        member?: GuildMember;
-        textChannel?: GuildTextBasedChannel;
-        message?: Message;
-        metadata?: any;
-    }): Promise<void>;
-    /**
-     * 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 if `position` is 1.
-     * If `position` is defined and not equal to 1, it will skip to the next song instead of the added song
-     * @param {number} [options.position=0] Position of the song/playlist to add to the queue,
-     * <= 0 to add to the end of the queue.
-     * @param {boolean} [options.unshift=false] (DEPRECATED) 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
-     */
-    playVoiceChannel(voiceChannel: VoiceBasedChannel, song: string | Song | SearchResult | Playlist, options?: {
-        skip?: boolean;
-        unshift?: boolean;
-        position?: number;
-        member?: GuildMember;
-        textChannel?: GuildTextBasedChannel;
-        message?: Message;
-        metadata?: any;
-    }): Promise<void>;
-    /**
-     * 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, { ... });
-     */
     createCustomPlaylist(songs: (string | Song | SearchResult)[], options?: {
         member?: GuildMember;
         properties?: Record<string, any>;
         parallel?: boolean;
         metadata?: any;
     }): Promise<Playlist>;
-    /**
-     * <info>Shorthand method of {@link DisTube#createCustomPlaylist} and {@link DisTube#play}
-     *
-     * If you doesn't have a user message (interaction,...),
-     * 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
-     * with `playlist`'s properties include `properties` parameter's properties such as
-     * `user`, `songs`, `duration`, `formattedDuration`, `thumbnail` like {@link Playlist}
-     * @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 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
-     * @deprecated Use {@link DisTube#createCustomPlaylist} and {@link DisTube#play} instead
-     */
-    playCustomPlaylist(message: Message<true>, songs: Array<string | Song | SearchResult>, properties?: Record<string, any>, options?: {
-        skip?: boolean;
-        /** @deprecated */
-        unshift?: boolean;
-        position?: number;
-        parallel?: boolean;
-        metadata?: any;
-    }): Promise<void>;
-    /**
-     * 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
-     * @param {'video'|'playlist'} [options.type='video'] Type of results (`video` or `playlist`).
-     * @param {boolean} [options.safeSearch=false] Whether or not use safe search (YouTube restricted mode)
-     * @throws {Error}
-     * @returns {Promise<Array<SearchResult>>} Array of results
-     */
     search(string: string, options?: {
         type?: "video" | "playlist";
         limit?: number;
         safeSearch?: boolean;
         retried?: boolean;
     }): Promise<Array<SearchResult>>;
-    /**
-     * Get the guild queue
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @returns {Queue?}
-     * @throws {Error}
-     * @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 == "queue") {
-     *         const queue = distube.getQueue(message);
-     *         message.channel.send('Current queue:\n' + queue.songs.map((song, id) =>
-     *             `**${id+1}**. [${song.name}](${song.url}) - \`${song.formattedDuration}\``
-     *         ).join("\n"));
-     *     }
-     * });
-     */
-    getQueue(queue: GuildIdResolvable): Queue | undefined;
-    /**
-     * Pause the guild stream
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @returns {Queue} The guild queue
-     * @throws {Error}
-     */
-    pause(queue: GuildIdResolvable): Queue;
-    /**
-     * Resume the guild stream
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @returns {Queue} The guild queue
-     * @throws {Error}
-     */
-    resume(queue: GuildIdResolvable): Queue;
-    /**
-     * Stop the guild stream
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @returns {Promise<void>}
-     * @throws {Error}
-     * @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 == "stop") {
-     *         distube.stop(message);
-     *         message.channel.send("Stopped the queue!");
-     *     }
-     * });
-     */
-    stop(queue: GuildIdResolvable): Promise<void>;
-    /**
-     * Set the guild stream's volume
-     * @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}
-     * @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 == "volume")
-     *         distube.setVolume(message, Number(args[0]));
-     * });
-     */
-    setVolume(queue: GuildIdResolvable, percent: number): Queue;
-    /**
-     * 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}
-     * @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 == "skip")
-     *         distube.skip(message);
-     * });
-     */
-    skip(queue: GuildIdResolvable): Promise<Song>;
-    /**
-     * Play the previous song
-     * @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
-     * 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 == "previous")
-     *         distube.previous(message);
-     * });
-     */
-    previous(queue: GuildIdResolvable): Promise<Song>;
-    /**
-     * Shuffle the guild queue songs
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @returns {Promise<Queue>} The guild queue
-     * @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 == "shuffle")
-     *         distube.shuffle(message);
-     * });
-     */
-    shuffle(queue: GuildIdResolvable): Promise<Queue>;
-    /**
-     * 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 {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)
-     * @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 == "jump")
-     *         distube.jump(message, parseInt(args[0]))
-     *             .catch(err => message.channel.send("Invalid song number."));
-     * });
-     */
-    jump(queue: GuildIdResolvable, num: number): Promise<Queue>;
-    /**
-     * 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 {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;
-     *     const args = message.content.slice(config.prefix.length).trim().split(/ +/g);
-     *     const command = args.shift();
-     *     if (command == "repeat") {
-     *         let mode = distube.setRepeatMode(message, parseInt(args[0]));
-     *         mode = mode ? mode == 2 ? "Repeat queue" : "Repeat song" : "Off";
-     *         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: GuildIdResolvable, mode?: number): number;
-    /**
-     * Toggle autoplay mode
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @returns {boolean} Autoplay mode state
-     * @throws {Error}
-     * @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 == "autoplay") {
-     *         const mode = distube.toggleAutoplay(message);
-     *         message.channel.send("Set autoplay mode to `" + (mode ? "On" : "Off") + "`");
-     *     }
-     * });
-     */
-    toggleAutoplay(queue: GuildIdResolvable): boolean;
-    /**
-     * Add related song to the queue
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @returns {Promise<Song>} The guild queue
-     */
-    addRelatedSong(queue: GuildIdResolvable): Promise<Song>;
-    /**
-     * 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 {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.
-     * @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 ([`3d`, `bassboost`, `echo`, `karaoke`, `nightcore`, `vaporwave`].includes(command)) {
-     *         const filter = distube.setFilter(message, command);
-     *         message.channel.send("Current queue filter: " + (filter.join(", ") || "Off"));
-     *     }
-     * });
-     */
-    setFilter(queue: GuildIdResolvable, filter: string | false, force?: boolean): Array<string>;
-    /**
-     * Set the playing time to another position
-     * @param {GuildIdResolvable} queue The type can be resolved to give a {@link Queue}
-     * @param {number} time Time in seconds
-     * @returns {Queue} Seeked queue
-     * @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 = 'seek')
-     *         distube.seek(message, Number(args[0]));
-     * });
-     */
-    seek(queue: GuildIdResolvable, time: number): Queue;
-    /**
-     * Emit error event
-     * @param {Error} error error
-     * @param {Discord.BaseGuildTextChannel} [channel] Text channel where the error is encountered.
-     * @private
-     */
+    getQueue(guild: GuildIdResolvable): Queue | undefined;
+    pause(guild: GuildIdResolvable): Queue;
+    resume(guild: GuildIdResolvable): Queue;
+    stop(guild: GuildIdResolvable): Promise<void>;
+    setVolume(guild: GuildIdResolvable, percent: number): Queue;
+    skip(guild: GuildIdResolvable): Promise<Song>;
+    previous(guild: GuildIdResolvable): Promise<Song>;
+    shuffle(guild: GuildIdResolvable): Promise<Queue>;
+    jump(guild: GuildIdResolvable, num: number): Promise<Song>;
+    setRepeatMode(guild: GuildIdResolvable, mode?: number): number;
+    toggleAutoplay(guild: GuildIdResolvable): boolean;
+    addRelatedSong(guild: GuildIdResolvable): Promise<Song>;
+    seek(guild: GuildIdResolvable, time: number): Queue;
     emitError(error: Error, channel?: GuildTextBasedChannel): void;
 }
 export default DisTube;
-/**
- * Emitted after DisTube add a new playlist to the playing {@link Queue}.
- *
- * @event DisTube#addList
- * @param {Queue} queue The guild queue
- * @param {Playlist} playlist Playlist info
- * @example
- * distube.on("addList", (queue, playlist) => queue.textChannel.send(
- *     `Added \`${playlist.name}\` playlist (${playlist.songs.length} songs) to the queue!`
- * ));
- */
-/**
- * Emitted after DisTube add a new song to the playing {@link Queue}.
- *
- * @event DisTube#addSong
- * @param {Queue} queue The guild queue
- * @param {Song} song Added song
- * @example
- * distube.on("addSong", (queue, song) => queue.textChannel.send(
- *     `Added ${song.name} - \`${song.formattedDuration}\` to the queue by ${song.user}.`
- * ));
- */
-/**
- * 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 DisTube encounters an error.
- *
- * @event DisTube#error
- * @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(
- *     "An error encountered: " + error
- * ));
- */
-/**
- * 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`.
- *
- * @event DisTube#finish
- * @param {Queue} queue The guild queue
- * @example
- * distube.on("finish", queue => queue.textChannel.send("No more song in queue"));
- */
-/**
- * Emitted when DisTube initialize a queue to change queue default properties.
- *
- * @event DisTube#initQueue
- * @param {Queue} queue The guild queue
- * @example
- * distube.on("initQueue", queue => {
- *     queue.autoplay = false;
- *     queue.volume = 100;
- * });
- */
-/**
- * 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
- * @example
- * distube.on("noRelated", queue => queue.textChannel.send("Can't find related video to play."));
- */
-/**
- * Emitted when DisTube play a song.
- *
- * 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
- * distube.on("playSong", (queue, song) => queue.textChannel.send(
- *     `Playing \`${song.name}\` - \`${song.formattedDuration}\`\nRequested by: ${song.user}`
- * ));
- */
-/**
- * Emitted when DisTube cannot find any results for the query.
- *
- * @event DisTube#searchNoResult
- * @param {Discord.Message} message The user message called play method
- * @param {string} query The search query
- * @example
- * 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} 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>
- *
- * @event DisTube#searchResult
- * @param {Discord.Message} message The user message called play method
- * @param {Array<SearchResult>} results Searched results
- * @param {string} query The search query
- * @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*`);
- * });
- */
-/**
- * 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
- * @param {string} query The search query
- * @example
- * // DisTubeOptions.searchSongs > 0
- * 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.
- *
- * @event DisTube#searchInvalidAnswer
- * @param {Discord.Message} message The user message called play method
- * @param {Discord.Message} answer The answered message of user
- * @param {string} query The search query
- * @example
- * // DisTubeOptions.searchSongs > 0
- * 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.
- *
- * @event DisTube#searchDone
- * @param {Discord.Message} message The user message called play method
- * @param {Discord.Message} answer The answered message of user
- * @param {string} query The search query
- */
-/**
- * Emitted when the bot is disconnected to a voice channel.
- *
- * @event DisTube#disconnect
- * @param {Queue} queue The guild queue
- */
-/**
- * Emitted when a {@link Queue} is deleted with any reasons.
- *
- * @event DisTube#deleteQueue
- * @param {Queue} queue The guild queue
- */
-/**
- * Emitted when DisTube finished a song.
- *
- * @event DisTube#finishSong
- * @param {Queue} queue The guild queue
- * @param {Song} song Finished song
- */
 //# sourceMappingURL=DisTube.d.ts.map

package/dist/DisTube.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DisTube.d.ts","sourceRoot":"","sources":["../src/DisTube.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,cAAc,EACd,mBAAmB,EAGnB,OAAO,EACP,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,IAAI,EAQL,MAAM,GAAG,CAAC;AACX,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,OAAO,EAAe,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAMlH,eAAO,MAAQ,OAAO,QAAoD,CAAC;AAE3E;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,aAAa,EAAE,YAAY,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B;;;;;;;;;;;;OAYG;gBACS,MAAM,EAAE,MAAM,EAAE,GAAG,GAAE,cAAmB;IAsDpD,MAAM,KAAK,OAAO,WAEjB;IAED;;;OAGG;IACH,IAAI,OAAO,WAEV;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACG,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAChB,6EAA6E;IACvE,IAAI,CACR,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,GAAG,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAChB,kFAAkF;IAC5E,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,iDAAiD;QACjD,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,GACA,OAAO,CAAC,IAAI,CAAC;IAgIhB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,gBAAgB,CACpB,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;;;;;;;;;;;;;OAiBG;IACG,oBAAoB,CACxB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAAE,EACvC,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,QAAQ,CAAC;IA4BpB;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,kBAAkB,CACtB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,EACtB,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAC1C,UAAU,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EACpC,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,kBAAkB;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IA6ChB;;;;;;;;;;;OAWG;IACG,MAAM,CACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACrG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAuB/B;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS;IAIrD;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMtC;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAMvC;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK;IAM3D;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMjD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAMjD;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAM3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAM9D;;;;;;;;;;;;;;;OAeG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAOjD;;;;OAIG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,EAAE,KAAK,UAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAMzF;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK;IAOnD;;;;;OAKG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;CAe/D;AAED,eAAe,OAAO,CAAC;AAEvB;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;;;;GAkBG;AAEH;;;;;;;;;;GAUG;AAEH;;;;;;;;;;;GAWG;AAEH;;;;;;;;GAQG;AAEH;;;;;GAKG;AAEH;;;;;GAKG;AAEH;;;;;;GAMG"}
+{"version":3,"file":"DisTube.d.ts","sourceRoot":"","sources":["../src/DisTube.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAEL,cAAc,EACd,mBAAmB,EAGnB,OAAO,EACP,QAAQ,EACR,KAAK,EACL,YAAY,EACZ,YAAY,EACZ,IAAI,EAOL,MAAM,GAAG,CAAC;AACX,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,qBAAqB,EAAE,OAAO,EAAe,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAIlH,eAAO,MAAQ,OAAO,QAAoD,CAAC;AAM3E,qBAAa,OAAQ,SAAQ,YAAY,CAAC,aAAa,CAAC;IACtD,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;IACjC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;IACrC,QAAQ,CAAC,gBAAgB,EAAE,eAAe,EAAE,CAAC;IAC7C,QAAQ,CAAC,aAAa,EAAE,YAAY,EAAE,CAAC;IACvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAcd,MAAM,EAAE,MAAM,EAAE,GAAG,GAAE,cAAmB;IAqDpD,MAAM,KAAK,OAAO,WAEjB;IAMD,IAAI,OAAO,WAEV;IAmCK,IAAI,CACR,YAAY,EAAE,iBAAiB,EAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,YAAY,GAAG,QAAQ,EAC7C,OAAO,GAAE;QACP,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,WAAW,CAAC,EAAE,qBAAqB,CAAC;QACpC,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,IAAI,CAAC;IAwGV,oBAAoB,CACxB,KAAK,EAAE,CAAC,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC,EAAE,EACvC,OAAO,GAAE;QACP,MAAM,CAAC,EAAE,WAAW,CAAC;QACrB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;KACX,GACL,OAAO,CAAC,QAAQ,CAAC;IAwCd,MAAM,CACV,MAAM,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,GAAG,UAAU,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAO,GACrG,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAyC/B,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK,GAAG,SAAS;IAUrD,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAYtC,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,KAAK;IAsBvC,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB7C,SAAS,CAAC,KAAK,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK;IAsB3D,IAAI,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB7C,QAAQ,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBjD,OAAO,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,KAAK,CAAC;IAwBjD,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuC1D,aAAa,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM;IAsB9D,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO;IAYjD,cAAc,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBvD,IAAI,CAAC,KAAK,EAAE,iBAAiB,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK;IAYnD,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,IAAI;CAa/D;AAED,eAAe,OAAO,CAAC"}