distube 2.8.18 → 3.0.0-0

package/dist/struct/Playlist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Playlist.js","sourceRoot":"","sources":["../../src/struct/Playlist.ts"],"names":[],"mappings":";;;AAAA,0BAAkD;AAKlD;;;GAGG;AACH,MAAa,QAAQ;IASnB;;;;;OAKG;IACH,YAAY,QAA6C,EAAE,MAAoB,EAAE,aAAkB,EAAE;;QACnG,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YAChC,MAAM,IAAI,gBAAY,CAAC,cAAc,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;SACzF;QACD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;YAClC,MAAM,IAAI,gBAAY,CAAC,cAAc,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;SAC5E;QACD,QAAQ;QACR,MAAM,IAAI,GAAG,QAAe,CAAC;QAC7B;;;WAGG;QACH,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5E;;;WAGG;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;QACnE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;YACpD,MAAM,IAAI,gBAAY,CAAC,gBAAgB,CAAC,CAAC;SAC1C;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;QACzC;;;WAGG;QACH,IAAI,CAAC,IAAI;YACP,IAAI,CAAC,IAAI;gBACT,IAAI,CAAC,KAAK;gBACV,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI;oBACjB,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,cAAc;oBAClE,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,iBAAiB,CAAC,CAAC;QAC7C;;;WAGG;QACH,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,WAAW,CAAC;QACxC;;;WAGG;QACH,IAAI,CAAC,SAAS,GAAG,CAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,GAAG,KAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAClF,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACrD,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;SACnB;IACH,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;;QACV,OAAO,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,KAAI,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACH,IAAI,iBAAiB;QACnB,OAAO,IAAA,kBAAc,EAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,MAAoB;;QAC/B,IAAI,MAAM,EAAE;YACV;;;eAGG;YACH,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;YACrB;;;eAGG;YACH,IAAI,CAAC,IAAI,GAAG,MAAA,IAAI,CAAC,MAAM,0CAAE,IAAI,CAAC;SAC/B;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AApGD,4BAoGC;AAED,kBAAe,QAAQ,CAAC","sourcesContent":["import { DisTubeError, formatDuration } from \"..\";\nimport type ytpl from \"@distube/ytpl\";\nimport type { PlaylistInfo, Song } from \"..\";\nimport type { GuildMember, User } from \"discord.js\";\n\n/**\n * Class representing a playlist.\n * @prop {string} source Playlist source\n */\nexport class Playlist implements PlaylistInfo {\n  source: string;\n  member?: GuildMember;\n  user?: User;\n  songs: Song[];\n  name: string;\n  url?: string;\n  thumbnail?: string;\n  [x: string]: any;\n  /**\n   * Create a playlist\n   * @param {Song[]|PlaylistInfo} playlist Playlist\n   * @param {Discord.GuildMember} member Requested user\n   * @param {Object} properties Custom properties\n   */\n  constructor(playlist: Song[] | ytpl.result | PlaylistInfo, member?: GuildMember, properties: any = {}) {\n    if (typeof playlist !== \"object\") {\n      throw new DisTubeError(\"INVALID_TYPE\", [\"Array<Song>\", \"object\"], playlist, \"playlist\");\n    }\n    if (typeof properties !== \"object\") {\n      throw new DisTubeError(\"INVALID_TYPE\", \"object\", properties, \"properties\");\n    }\n    // FIXME\n    const info = playlist as any;\n    /**\n     * The source of the playlist\n     * @type {string}\n     */\n    this.source = (info.source || properties.source || \"youtube\").toLowerCase();\n    /**\n     * Playlist songs.\n     * @type {Array<Song>}\n     */\n    this.songs = Array.isArray(info) ? info : info.items || info.songs;\n    if (!Array.isArray(this.songs) || !this.songs.length) {\n      throw new DisTubeError(\"EMPTY_PLAYLIST\");\n    }\n    this._patchMember(member || info.member);\n    /**\n     * Playlist name.\n     * @type {string}\n     */\n    this.name =\n      info.name ||\n      info.title ||\n      (this.songs[0].name\n        ? `${this.songs[0].name} and ${this.songs.length - 1} more songs.`\n        : `${this.songs.length} songs playlist`);\n    /**\n     * Playlist URL.\n     * @type {string}\n     */\n    this.url = info.url || info.webpage_url;\n    /**\n     * Playlist thumbnail.\n     * @type {?string}\n     */\n    this.thumbnail = info.thumbnail?.url || info.thumbnail || this.songs[0].thumbnail;\n    for (const [key, value] of Object.entries(properties)) {\n      this[key] = value;\n    }\n  }\n\n  /**\n   * Playlist duration in second.\n   * @type {number}\n   */\n  get duration() {\n    return this.songs?.reduce((prev, next) => prev + (next.duration || 0), 0) || 0;\n  }\n\n  /**\n   * Formatted duration string `hh:mm:ss`.\n   * @type {string}\n   */\n  get formattedDuration() {\n    return formatDuration(this.duration);\n  }\n\n  /**\n   * @param {?Discord.GuildMember} [member] Requested user\n   * @private\n   * @returns {Playlist}\n   */\n  _patchMember(member?: GuildMember): Playlist {\n    if (member) {\n      /**\n       * User requested.\n       * @type {?Discord.GuildMember}\n       */\n      this.member = member;\n      /**\n       * User requested.\n       * @type {?Discord.User}\n       */\n      this.user = this.member?.user;\n    }\n    this.songs.map(s => s.constructor.name === \"Song\" && s._patchPlaylist(this, this.member));\n    return this;\n  }\n}\n\nexport default Playlist;\n"]}

package/dist/struct/Plugin.d.ts

@@ -0,0 +1,82 @@
+import type { Client, TextChannel } from "discord.js";
+import type { DisTube, DisTubeEvents, DisTubeHandler, DisTubeVoiceManager, Options, PluginType, QueueManager, Song } from "..";
+/**
+ * DisTube Plugin
+ * @abstract
+ * @private
+ */
+export declare abstract class Plugin {
+    type: PluginType;
+    distube: DisTube;
+    init(distube: DisTube): void;
+    /**
+     * Type of the plugin
+     * @name Plugin#type
+     * @type {PluginType}
+     */
+    /**
+     * Emit the {@link DisTube} of this base
+     * @param {string} eventName Event name
+     * @param {...any} args arguments
+     * @returns {boolean}
+     */
+    emit(eventName: keyof DisTubeEvents, ...args: any): boolean;
+    /**
+     * Emit error event
+     * @param {Error} error error
+     * @param {Discord.TextChannel?} channel Text channel where the error is encountered.
+     */
+    emitError(error: Error, channel?: TextChannel): void;
+    /**
+     * The queue manager
+     * @type {QueueManager}
+     * @readonly
+     */
+    get queues(): QueueManager;
+    /**
+     * The voice manager
+     * @type {DisTubeVoiceManager}
+     * @readonly
+     */
+    get voices(): DisTubeVoiceManager;
+    /**
+     * Discord.js client
+     * @type {Discord.Client}
+     * @readonly
+     */
+    get client(): Client;
+    /**
+     * DisTube options
+     * @type {DisTubeOptions}
+     * @readonly
+     */
+    get options(): Options;
+    /**
+     * DisTube handler
+     * @type {DisTubeHandler}
+     * @readonly
+     */
+    get handler(): DisTubeHandler;
+    /**
+     * Check if the url is working with this plugin
+     * @param {string} url Input url
+     * @returns {Promise<boolean>}
+     */
+    validate(url: string): Promise<boolean>;
+    /**
+     * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
+     * Not needed if the plugin plays song from YouTube.
+     * @param {string} url Input url
+     * @returns {Promise<string>}
+     */
+    getStreamURL(url: string): Promise<string>;
+    /**
+     * (Optional) Get related songs from a supported url. {@link Song#member} should be `undefined`.
+     * Not needed to add {@link Song#related} because it will be added with this function later.
+     * @param {string} url Input url
+     * @returns {Promise<Song[]>}
+     */
+    getRelatedSongs(url: string): Promise<Song[]>;
+}
+export default Plugin;
+//# sourceMappingURL=Plugin.d.ts.map

package/dist/struct/Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/struct/Plugin.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACtD,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,OAAO,EACP,UAAU,EACV,YAAY,EACZ,IAAI,EACL,MAAM,IAAI,CAAC;AAEZ;;;;GAIG;AACH,8BAAsB,MAAM;IAC1B,IAAI,EAAG,UAAU,CAAC;IAClB,OAAO,EAAG,OAAO,CAAC;IAClB,IAAI,CAAC,OAAO,EAAE,OAAO;IAOrB;;;;OAIG;IACH;;;;;OAKG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,OAAO;IAG3D;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,WAAW;IAG7C;;;;OAIG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IACD;;;;OAIG;IACH,IAAI,MAAM,IAAI,mBAAmB,CAEhC;IACD;;;;OAIG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IACD;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IACD;;;;OAIG;IACH,IAAI,OAAO,IAAI,cAAc,CAE5B;IACD;;;;OAIG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAG7C;;;;;OAKG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAGhD;;;;;OAKG;IACG,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;CAGpD;AAED,eAAe,MAAM,CAAC"}

package/dist/struct/Plugin.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plugin = void 0;
+/**
+ * DisTube Plugin
+ * @abstract
+ * @private
+ */
+class Plugin {
+    init(distube) {
+        /**
+         * DisTube
+         * @type {DisTube}
+         */
+        this.distube = distube;
+    }
+    /**
+     * Type of the plugin
+     * @name Plugin#type
+     * @type {PluginType}
+     */
+    /**
+     * Emit the {@link DisTube} of this base
+     * @param {string} eventName Event name
+     * @param {...any} args arguments
+     * @returns {boolean}
+     */
+    emit(eventName, ...args) {
+        return this.distube.emit(eventName, ...args);
+    }
+    /**
+     * Emit error event
+     * @param {Error} error error
+     * @param {Discord.TextChannel?} channel Text channel where the error is encountered.
+     */
+    emitError(error, channel) {
+        this.distube.emitError(error, channel);
+    }
+    /**
+     * The queue manager
+     * @type {QueueManager}
+     * @readonly
+     */
+    get queues() {
+        return this.distube.queues;
+    }
+    /**
+     * The voice manager
+     * @type {DisTubeVoiceManager}
+     * @readonly
+     */
+    get voices() {
+        return this.distube.voices;
+    }
+    /**
+     * Discord.js client
+     * @type {Discord.Client}
+     * @readonly
+     */
+    get client() {
+        return this.distube.client;
+    }
+    /**
+     * DisTube options
+     * @type {DisTubeOptions}
+     * @readonly
+     */
+    get options() {
+        return this.distube.options;
+    }
+    /**
+     * DisTube handler
+     * @type {DisTubeHandler}
+     * @readonly
+     */
+    get handler() {
+        return this.distube.handler;
+    }
+    /**
+     * Check if the url is working with this plugin
+     * @param {string} url Input url
+     * @returns {Promise<boolean>}
+     */
+    async validate(url) {
+        return false;
+    }
+    /**
+     * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
+     * Not needed if the plugin plays song from YouTube.
+     * @param {string} url Input url
+     * @returns {Promise<string>}
+     */
+    async getStreamURL(url) {
+        return url;
+    }
+    /**
+     * (Optional) Get related songs from a supported url. {@link Song#member} should be `undefined`.
+     * Not needed to add {@link Song#related} because it will be added with this function later.
+     * @param {string} url Input url
+     * @returns {Promise<Song[]>}
+     */
+    async getRelatedSongs(url) {
+        return [];
+    }
+}
+exports.Plugin = Plugin;
+exports.default = Plugin;
+//# sourceMappingURL=Plugin.js.map

package/dist/struct/Plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../src/struct/Plugin.ts"],"names":[],"mappings":";;;AAaA;;;;GAIG;AACH,MAAsB,MAAM;IAG1B,IAAI,CAAC,OAAgB;QACnB;;;WAGG;QACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IACD;;;;OAIG;IACH;;;;;OAKG;IACH,IAAI,CAAC,SAA8B,EAAE,GAAG,IAAS;QAC/C,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,IAAI,CAAC,CAAC;IAC/C,CAAC;IACD;;;;OAIG;IACH,SAAS,CAAC,KAAY,EAAE,OAAqB;QAC3C,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IACD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IACD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IACD;;;;OAIG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IACD;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IACD;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;IAC9B,CAAC;IACD;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,GAAW;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,GAAW;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;;OAKG;IACH,KAAK,CAAC,eAAe,CAAC,GAAW;QAC/B,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAlGD,wBAkGC;AAED,kBAAe,MAAM,CAAC","sourcesContent":["/* eslint-disable @typescript-eslint/require-await, @typescript-eslint/no-unused-vars */\nimport type { Client, TextChannel } from \"discord.js\";\nimport type {\n  DisTube,\n  DisTubeEvents,\n  DisTubeHandler,\n  DisTubeVoiceManager,\n  Options,\n  PluginType,\n  QueueManager,\n  Song,\n} from \"..\";\n\n/**\n * DisTube Plugin\n * @abstract\n * @private\n */\nexport abstract class Plugin {\n  type!: PluginType;\n  distube!: DisTube;\n  init(distube: DisTube) {\n    /**\n     * DisTube\n     * @type {DisTube}\n     */\n    this.distube = distube;\n  }\n  /**\n   * Type of the plugin\n   * @name Plugin#type\n   * @type {PluginType}\n   */\n  /**\n   * Emit the {@link DisTube} of this base\n   * @param {string} eventName Event name\n   * @param {...any} args arguments\n   * @returns {boolean}\n   */\n  emit(eventName: keyof DisTubeEvents, ...args: any): boolean {\n    return this.distube.emit(eventName, ...args);\n  }\n  /**\n   * Emit error event\n   * @param {Error} error error\n   * @param {Discord.TextChannel?} channel Text channel where the error is encountered.\n   */\n  emitError(error: Error, channel?: TextChannel) {\n    this.distube.emitError(error, channel);\n  }\n  /**\n   * The queue manager\n   * @type {QueueManager}\n   * @readonly\n   */\n  get queues(): QueueManager {\n    return this.distube.queues;\n  }\n  /**\n   * The voice manager\n   * @type {DisTubeVoiceManager}\n   * @readonly\n   */\n  get voices(): DisTubeVoiceManager {\n    return this.distube.voices;\n  }\n  /**\n   * Discord.js client\n   * @type {Discord.Client}\n   * @readonly\n   */\n  get client(): Client {\n    return this.distube.client;\n  }\n  /**\n   * DisTube options\n   * @type {DisTubeOptions}\n   * @readonly\n   */\n  get options(): Options {\n    return this.distube.options;\n  }\n  /**\n   * DisTube handler\n   * @type {DisTubeHandler}\n   * @readonly\n   */\n  get handler(): DisTubeHandler {\n    return this.distube.handler;\n  }\n  /**\n   * Check if the url is working with this plugin\n   * @param {string} url Input url\n   * @returns {Promise<boolean>}\n   */\n  async validate(url: string): Promise<boolean> {\n    return false;\n  }\n  /**\n   * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.\n   * Not needed if the plugin plays song from YouTube.\n   * @param {string} url Input url\n   * @returns {Promise<string>}\n   */\n  async getStreamURL(url: string): Promise<string> {\n    return url;\n  }\n  /**\n   * (Optional) Get related songs from a supported url. {@link Song#member} should be `undefined`.\n   * Not needed to add {@link Song#related} because it will be added with this function later.\n   * @param {string} url Input url\n   * @returns {Promise<Song[]>}\n   */\n  async getRelatedSongs(url: string): Promise<Song[]> {\n    return [];\n  }\n}\n\nexport default Plugin;\n"]}

package/dist/struct/Queue.d.ts

@@ -0,0 +1,217 @@
+/// <reference types="node" />
+import { DisTubeBase } from "../core";
+import { RepeatMode, Song, TaskQueue } from "..";
+import type { GuildMember, Snowflake, TextChannel } from "discord.js";
+import type { DisTube, DisTubeVoice, DisTubeVoiceEvents, SearchResult } from "..";
+/**
+ * Represents a queue.
+ * @extends DisTubeBase
+ */
+export declare class Queue extends DisTubeBase {
+    id: Snowflake;
+    /**
+     * Voice connection of this queue
+     */
+    voice: DisTubeVoice;
+    /**
+     * List of songs in the queue (The first one is the playing song)
+     */
+    songs: Song[];
+    /**
+     * List of the previous songs.
+     */
+    previousSongs: Song[];
+    /**
+     * Whether stream is currently stopped.
+     * @private
+     */
+    stopped: boolean;
+    /**
+     * Whether or not the last song was skipped to next song.
+     * @private
+     */
+    next: boolean;
+    /**
+     * Whether or not the last song was skipped to previous song.
+     * @private
+     */
+    prev: boolean;
+    /**
+     * Whether or not the stream is currently playing.
+     */
+    playing: boolean;
+    /**
+     * Whether or not the stream is currently paused.
+     */
+    paused: boolean;
+    /**
+     * Type of repeat mode (`0` is disabled, `1` is repeating a song, `2` is repeating all the queue).
+     * Default value: `0` (disabled)
+     */
+    repeatMode: RepeatMode;
+    /**
+     * Whether or not the autoplay mode is enabled.
+     * Default value: `false`
+     */
+    autoplay: boolean;
+    /**
+     * Enabled audio filters.
+     * Available filters: {@link Filters}
+     */
+    filters: string[];
+    /**
+     * What time in the song to begin (in seconds).
+     */
+    beginTime: number;
+    /**
+     * The text channel of the Queue. (Default: where the first command is called).
+     */
+    textChannel?: TextChannel;
+    /**
+     * Timeout for checking empty channel
+     * @private
+     */
+    emptyTimeout?: NodeJS.Timeout;
+    /**
+     * The client user as a `GuildMember` of this queue's guild
+     */
+    clientMember: GuildMember;
+    /**
+     * Task queuing system
+     */
+    taskQueue: TaskQueue;
+    listeners?: DisTubeVoiceEvents;
+    /**
+     * Create a queue for the guild
+     * @param {DisTube} distube DisTube
+     * @param {DisTubeVoice} voice Voice connection
+     * @param {Song|Song[]} song First song(s)
+     * @param {Discord.TextChannel?} textChannel Default text channel
+     */
+    constructor(distube: DisTube, voice: DisTubeVoice, song: Song | Song[], textChannel?: TextChannel);
+    /**
+     * Formatted duration string.
+     * @type {string}
+     */
+    get formattedDuration(): string;
+    /**
+     * Queue's duration.
+     * @type {number}
+     */
+    get duration(): number;
+    /**
+     * What time in the song is playing (in seconds).
+     * @type {number}
+     */
+    get currentTime(): number;
+    /**
+     * Formatted {@link Queue#currentTime} string.
+     * @type {string}
+     */
+    get formattedCurrentTime(): string;
+    /**
+     * The voice channel playing in.
+     * @type {Discord.VoiceChannel|Discord.StageChannel|null}
+     */
+    get voiceChannel(): import("discord.js").VoiceChannel | import("discord.js").StageChannel | null;
+    get volume(): number;
+    set volume(value: number);
+    /**
+     * Add a Song or an array of Song to the queue
+     * @param {Song|Song[]} song Song to add
+     * @param {number} [position=-1] Position to add, < 0 to add to the end of the queue
+     * @param {boolean} [queuing=true] Wether or not waiting for unfinished tasks
+     * @throws {Error}
+     * @returns {Queue} The guild queue
+     */
+    addToQueue(song: Song | SearchResult | (Song | SearchResult)[], position?: number): Queue;
+    /**
+     * Pause the guild stream
+     * @returns {Queue} The guild queue
+     */
+    pause(): Queue;
+    /**
+     * Resume the guild stream
+     * @returns {Queue} The guild queue
+     */
+    resume(): Queue;
+    /**
+     * Set the guild stream's volume
+     * @param {number} percent The percentage of volume you want to set
+     * @returns {Queue} The guild queue
+     */
+    setVolume(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>
+     * @returns {Promise<Song>} The song will skip to
+     * @throws {Error}
+     */
+    skip(): Promise<Song>;
+    /**
+     * Play the previous song if exists
+     * @returns {Song} The guild queue
+     * @throws {Error}
+     */
+    previous(): Promise<Song>;
+    /**
+     * Shuffle the queue's songs
+     * @returns {Promise<Queue>} The guild queue
+     */
+    shuffle(): Promise<Queue>;
+    /**
+     * Jump to the song position in the queue.
+     * The next one is 1, 2,...
+     * The previous one is -1, -2,...
+     * @param {number} position The song position to play
+     * @returns {Promise<Queue>} The guild queue
+     * @throws {Error} if `num` is invalid number
+     */
+    jump(position: number): Promise<Queue>;
+    /**
+     * Set the repeat mode of the guild queue.\
+     * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
+     * @param {RepeatMode?} [mode] The repeat modes (toggle if `undefined`)
+     * @returns {RepeatMode} The new repeat mode
+     */
+    setRepeatMode(mode?: RepeatMode): RepeatMode;
+    /**
+     * Enable or disable filter(s) of the queue.
+     * Available filters: {@link Filters}
+     * @param {string|string[]|false} filter A filter name, an array of filter name or `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.
+     * @throws {Error}
+     */
+    setFilter(filter: string | string[] | false, force?: boolean): Array<string>;
+    /**
+     * Set the playing time to another position
+     * @param {number} time Time in seconds
+     * @returns {Queue} The guild queue
+     */
+    seek(time: number): Queue;
+    /**
+     * Add a related song of the playing song to the queue
+     * @returns {Promise<Song>} The added song
+     * @throws {Error}
+     */
+    addRelatedSong(): Promise<Song>;
+    /**
+     * Stop the guild stream
+     */
+    stop(): Promise<void>;
+    /**
+     * Delete the queue from the manager
+     * (This does not leave the queue even if {@link DisTubeOptions|DisTubeOptions.leaveOnStop} is enabled)
+     * @private
+     */
+    delete(): void;
+    /**
+     * Toggle autoplay mode
+     * @returns {boolean} Autoplay mode state
+     */
+    toggleAutoplay(): boolean;
+}
+export default Queue;
+//# sourceMappingURL=Queue.d.ts.map

package/dist/struct/Queue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Queue.d.ts","sourceRoot":"","sources":["../../src/struct/Queue.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAgB,UAAU,EAAE,IAAI,EAAE,SAAS,EAAkB,MAAM,IAAI,CAAC;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,KAAK,EAAE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAElF;;;GAGG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC,EAAE,EAAE,SAAS,CAAC;IACd;;OAEG;IACH,KAAK,EAAE,YAAY,CAAC;IACpB;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IACd;;OAEG;IACH,aAAa,EAAE,IAAI,EAAE,CAAC;IACtB;;;OAGG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;;OAGG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IAC9B;;OAEG;IACH,YAAY,EAAE,WAAW,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B;;;;;;OAMG;gBACS,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,EAAE,WAAW,CAAC,EAAE,WAAW;IA2GjG;;;OAGG;IACH,IAAI,iBAAiB,WAEpB;IACD;;;OAGG;IACH,IAAI,QAAQ,WAEX;IACD;;;OAGG;IACH,IAAI,WAAW,WAEd;IACD;;;OAGG;IACH,IAAI,oBAAoB,WAEvB;IACD;;;OAGG;IACH,IAAI,YAAY,iFAEf;IACD,IAAI,MAAM,IAGQ,MAAM,CADvB;IACD,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAEvB;IACD;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,IAAI,GAAG,YAAY,GAAG,CAAC,IAAI,GAAG,YAAY,CAAC,EAAE,EAAE,QAAQ,SAAK,GAAG,KAAK;IAkBrF;;;OAGG;IACH,KAAK,IAAI,KAAK;IAOd;;;OAGG;IACH,MAAM,IAAI,KAAK;IAOf;;;;OAIG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK;IAKjC;;;;;;OAMG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB3B;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAgB/B;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC;IAe/B;;;;;;;OAOG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAgC5C;;;;;OAKG;IACH,aAAa,CAAC,IAAI,CAAC,EAAE,UAAU,GAAG,UAAU;IAS5C;;;;;;;OAOG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,KAAK,UAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAwB1E;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK;IAOzB;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IASrC;;OAEG;IACG,IAAI;IAWV;;;;OAIG;IACH,MAAM;IAYN;;;OAGG;IACH,cAAc,IAAI,OAAO;CAI1B;AAED,eAAe,KAAK,CAAC"}