distube 5.0.6 → 5.1.0

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import * as discord_js from 'discord.js';
-import { GuildMember, Snowflake, Message, GuildTextBasedChannel, VoiceBasedChannel, VoiceState, Guild, Interaction, Client, Collection, ClientOptions } from 'discord.js';
+import { GuildMember, Snowflake, Message, GuildTextBasedChannel, VoiceBasedChannel, VoiceState, Guild, Interaction, Collection, Client, ClientOptions } from 'discord.js';
+import { AudioResource, AudioPlayer, VoiceConnection } from '@discordjs/voice';
 import { TypedEmitter } from 'tiny-typed-emitter';
-import { AudioPlayer, VoiceConnection, AudioResource } from '@discordjs/voice';
-import { Transform, TransformCallback } from 'stream';
-import { ChildProcess } from 'child_process';
+import { ChildProcess } from 'node:child_process';
+import { Transform, TransformCallback } from 'node:stream';
 
 type Awaitable<T = any> = T | PromiseLike<T>;
 declare enum Events {
@@ -200,6 +200,13 @@ type PlayHandlerOptions = {
      */
     textChannel?: GuildTextBasedChannel;
 };
+interface JumpOptions {
+    /**
+     * [Default: false] Whether or not skipped song(s) will be added to the end of the
+     * queue
+     */
+    requeue?: boolean;
+}
 interface PlayOptions<T = unknown> extends PlayHandlerOptions, ResolveOptions<T> {
     /**
      * Called message (For built-in search events. If this is a {@link
@@ -300,6 +307,8 @@ type FFmpegOptions = {
     args: FFmpegArgs;
 };
 
+declare const version: string;
+
 /**
  * Default DisTube audio filters.
  */
@@ -314,150 +323,6 @@ declare const defaultOptions: {
     joinNewVoiceChannel: true;
 };
 
-declare const ERROR_MESSAGES: {
-    INVALID_TYPE: (expected: (number | string) | readonly (number | string)[], got: any, name?: string) => string;
-    NUMBER_COMPARE: (name: string, expected: string, value: number) => string;
-    EMPTY_ARRAY: (name: string) => string;
-    EMPTY_FILTERED_ARRAY: (name: string, type: string) => string;
-    EMPTY_STRING: (name: string) => string;
-    INVALID_KEY: (obj: string, key: string) => string;
-    MISSING_KEY: (obj: string, key: string) => string;
-    MISSING_KEYS: (obj: string, key: string[], all: boolean) => string;
-    MISSING_INTENTS: (i: string) => string;
-    DISABLED_OPTION: (o: string) => string;
-    ENABLED_OPTION: (o: string) => string;
-    NOT_IN_VOICE: string;
-    VOICE_FULL: string;
-    VOICE_ALREADY_CREATED: string;
-    VOICE_CONNECT_FAILED: (s: number) => string;
-    VOICE_MISSING_PERMS: string;
-    VOICE_RECONNECT_FAILED: string;
-    VOICE_DIFFERENT_GUILD: string;
-    VOICE_DIFFERENT_CLIENT: string;
-    FFMPEG_EXITED: (code: number) => string;
-    FFMPEG_NOT_INSTALLED: (path: string) => string;
-    ENCRYPTION_LIBRARIES_MISSING: string;
-    NO_QUEUE: string;
-    QUEUE_EXIST: string;
-    QUEUE_STOPPED: string;
-    PAUSED: string;
-    RESUMED: string;
-    NO_PREVIOUS: string;
-    NO_UP_NEXT: string;
-    NO_SONG_POSITION: string;
-    NO_PLAYING_SONG: string;
-    NO_EXTRACTOR_PLUGIN: string;
-    NO_RELATED: string;
-    CANNOT_PLAY_RELATED: string;
-    UNAVAILABLE_VIDEO: string;
-    UNPLAYABLE_FORMATS: string;
-    NON_NSFW: string;
-    NOT_SUPPORTED_URL: string;
-    NOT_SUPPORTED_SONG: (song: string) => string;
-    NO_VALID_SONG: string;
-    CANNOT_RESOLVE_SONG: (t: any) => string;
-    CANNOT_GET_STREAM_URL: (song: string) => string;
-    CANNOT_GET_SEARCH_QUERY: (song: string) => string;
-    NO_RESULT: (query: string) => string;
-    NO_STREAM_URL: (song: string) => string;
-    EMPTY_FILTERED_PLAYLIST: string;
-    EMPTY_PLAYLIST: string;
-};
-type ErrorMessage = typeof ERROR_MESSAGES;
-type ErrorCode = keyof ErrorMessage;
-type StaticErrorCode = {
-    [K in ErrorCode]-?: ErrorMessage[K] extends string ? K : never;
-}[ErrorCode];
-type TemplateErrorCode = Exclude<keyof typeof ERROR_MESSAGES, StaticErrorCode>;
-declare class DisTubeError<T extends string = any> extends Error {
-    errorCode: string;
-    constructor(code: T extends StaticErrorCode ? T : never);
-    constructor(code: T extends TemplateErrorCode ? T : never, ...args: Parameters<ErrorMessage[typeof code]>);
-    constructor(code: TemplateErrorCode, _: never);
-    constructor(code: T extends ErrorCode ? never : T, message: string);
-    get name(): string;
-    get code(): string;
-}
-
-/**
- * Task queuing system
- */
-declare class TaskQueue {
-    #private;
-    /**
-     * Waits for last task finished and queues a new task
-     */
-    queuing(): Promise<void>;
-    /**
-     * Removes the finished task and processes the next task
-     */
-    resolve(): void;
-    /**
-     * The remaining number of tasks
-     */
-    get remaining(): number;
-}
-
-/**
- * Class representing a playlist.
- */
-declare class Playlist<T = unknown> implements PlaylistInfo {
-    #private;
-    /**
-     * Playlist source.
-     */
-    source: string;
-    /**
-     * Songs in the playlist.
-     */
-    songs: Song[];
-    /**
-     * Playlist ID.
-     */
-    id?: string;
-    /**
-     * Playlist name.
-     */
-    name?: string;
-    /**
-     * Playlist URL.
-     */
-    url?: string;
-    /**
-     * Playlist thumbnail.
-     */
-    thumbnail?: string;
-    /**
-     * Create a Playlist
-     * @param playlist  - Raw playlist info
-     * @param options   - Optional data
-     */
-    constructor(playlist: PlaylistInfo, { member, metadata }?: ResolveOptions<T>);
-    /**
-     * Playlist duration in second.
-     */
-    get duration(): number;
-    /**
-     * Formatted duration string `hh:mm:ss`.
-     */
-    get formattedDuration(): string;
-    /**
-     * User requested.
-     */
-    get member(): GuildMember | undefined;
-    set member(member: GuildMember | undefined);
-    /**
-     * User requested.
-     */
-    get user(): discord_js.User | undefined;
-    /**
-     * Optional metadata that can be used to identify the playlist.
-     */
-    get metadata(): T;
-    set metadata(metadata: T);
-    toString(): string;
-}
-
 /**
  * Class representing a song.
  */
@@ -578,129 +443,102 @@ declare class Song<T = unknown> {
     toString(): string;
 }
 
-declare abstract class DisTubeBase {
-    distube: DisTube;
-    constructor(distube: DisTube);
+/**
+ * Class representing a playlist.
+ */
+declare class Playlist<T = unknown> implements PlaylistInfo {
+    #private;
     /**
-     * Emit the {@link DisTube} of this base
-     * @param eventName - Event name
-     * @param args      - arguments
+     * Playlist source.
      */
-    emit(eventName: keyof DisTubeEvents, ...args: any): boolean;
+    source: string;
     /**
-     * Emit error event
-     * @param error   - error
-     * @param queue   - The queue encountered the error
-     * @param song    - The playing song when encountered the error
+     * Songs in the playlist.
      */
-    emitError(error: Error, queue: Queue, song?: Song): void;
+    songs: Song[];
     /**
-     * Emit debug event
-     * @param message - debug message
+     * Playlist ID.
      */
-    debug(message: string): void;
+    id?: string;
     /**
-     * The queue manager
+     * Playlist name.
      */
-    get queues(): QueueManager;
+    name?: string;
     /**
-     * The voice manager
+     * Playlist URL.
      */
-    get voices(): DisTubeVoiceManager;
+    url?: string;
     /**
-     * Discord.js client
+     * Playlist thumbnail.
      */
-    get client(): Client;
+    thumbnail?: string;
     /**
-     * DisTube options
+     * Create a Playlist
+     * @param playlist  - Raw playlist info
+     * @param options   - Optional data
      */
-    get options(): Options;
+    constructor(playlist: PlaylistInfo, { member, metadata }?: ResolveOptions<T>);
     /**
-     * DisTube handler
+     * Playlist duration in second.
      */
-    get handler(): DisTubeHandler;
+    get duration(): number;
     /**
-     * DisTube plugins
+     * Formatted duration string `hh:mm:ss`.
      */
-    get plugins(): DisTubePlugin[];
-}
-
-/**
- * Create a voice connection to the voice channel
- */
-declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
-    #private;
-    readonly id: Snowflake;
-    readonly voices: DisTubeVoiceManager;
-    readonly audioPlayer: AudioPlayer;
-    connection: VoiceConnection;
-    emittedError: boolean;
-    isDisconnected: boolean;
-    stream?: DisTubeStream;
-    pausingStream?: DisTubeStream;
-    constructor(voiceManager: DisTubeVoiceManager, channel: VoiceBasedChannel);
+    get formattedDuration(): string;
     /**
-     * The voice channel id the bot is in
+     * User requested.
      */
-    get channelId(): string | undefined;
-    get channel(): VoiceBasedChannel;
-    set channel(channel: VoiceBasedChannel);
+    get member(): GuildMember | undefined;
+    set member(member: GuildMember | undefined);
     /**
-     * Join a voice channel with this connection
-     * @param channel - A voice channel
+     * User requested.
      */
-    join(channel?: VoiceBasedChannel): Promise<DisTubeVoice>;
+    get user(): discord_js.User | undefined;
     /**
-     * Leave the voice channel of this connection
-     * @param error - Optional, an error to emit with 'error' event.
+     * Optional metadata that can be used to identify the playlist.
      */
-    leave(error?: Error): void;
+    get metadata(): T;
+    set metadata(metadata: T);
+    toString(): string;
+}
+
+/**
+ * DisTube's Handler
+ */
+declare class DisTubeHandler extends DisTubeBase {
+    #private;
+    resolve<T = unknown>(song: Song<T>, options?: Omit<ResolveOptions, "metadata">): Promise<Song<T>>;
+    resolve<T = unknown>(song: Playlist<T>, options?: Omit<ResolveOptions, "metadata">): Promise<Playlist<T>>;
+    resolve<T = unknown>(song: string, options?: ResolveOptions<T>): Promise<Song<T> | Playlist<T>>;
+    resolve<T = unknown>(song: Song, options: ResolveOptions<T>): Promise<Song<T>>;
+    resolve<T = unknown>(song: Playlist, options: ResolveOptions<T>): Promise<Playlist<T>>;
+    resolve(song: string | Song | Playlist, options?: ResolveOptions): Promise<Song | Playlist>;
+    _getPluginFromURL(url: string): Promise<DisTubePlugin | null>;
+    _getPluginFromSong(song: Song): Promise<DisTubePlugin | null>;
+    _getPluginFromSong<T extends PluginType>(song: Song, types: T[], validate?: boolean): Promise<(DisTubePlugin & {
+        type: T;
+    }) | null>;
     /**
-     * Stop the playing stream
-     * @param force - If true, will force the {@link DisTubeVoice#audioPlayer} to enter the Idle state even
-     *                if the {@link DisTubeStream#audioResource} has silence padding frames.
-     */
-    stop(force?: boolean): void;
-    /**
-     * Play a {@link DisTubeStream}
-     * @param dtStream - DisTubeStream
-     */
-    play(dtStream: DisTubeStream): Promise<void>;
-    set volume(volume: number);
-    /**
-     * Get or set the volume percentage
-     */
-    get volume(): number;
-    /**
-     * Playback duration of the audio resource in seconds
-     */
-    get playbackDuration(): number;
-    pause(): void;
-    unpause(): void;
-    /**
-     * Whether the bot is self-deafened
-     */
-    get selfDeaf(): boolean;
-    /**
-     * Whether the bot is self-muted
-     */
-    get selfMute(): boolean;
-    /**
-     * Self-deafens/undeafens the bot.
-     * @param selfDeaf - Whether or not the bot should be self-deafened
-     * @returns true if the voice state was successfully updated, otherwise false
-     */
-    setSelfDeaf(selfDeaf: boolean): boolean;
-    /**
-     * Self-mutes/unmutes the bot.
-     * @param selfMute - Whether or not the bot should be self-muted
-     * @returns true if the voice state was successfully updated, otherwise false
-     */
-    setSelfMute(selfMute: boolean): boolean;
-    /**
-     * The voice state of this connection
+     * Get {@link Song}'s stream info and attach it to the song.
+     * @param song - A Song
      */
-    get voiceState(): VoiceState | undefined;
+    attachStreamInfo(song: Song): Promise<void>;
+    followRedirectLink(url: string, maxRedirect?: number): Promise<string>;
+}
+
+declare class Options {
+    #private;
+    plugins: DisTubePlugin[];
+    emitNewSongOnly: boolean;
+    savePreviousSongs: boolean;
+    customFilters?: Filters;
+    nsfw: boolean;
+    emitAddSongWhenCreatingQueue: boolean;
+    emitAddListWhenCreatingQueue: boolean;
+    joinNewVoiceChannel: boolean;
+    ffmpeg: FFmpegOptions;
+    constructor(options: DisTubeOptions);
 }
 
 /**
@@ -748,41 +586,81 @@ declare class VolumeTransformer extends Transform {
 }
 
 /**
- * DisTube's Handler
+ * Create a voice connection to the voice channel
  */
-declare class DisTubeHandler extends DisTubeBase {
+declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
     #private;
-    resolve<T = unknown>(song: Song<T>, options?: Omit<ResolveOptions, "metadata">): Promise<Song<T>>;
-    resolve<T = unknown>(song: Playlist<T>, options?: Omit<ResolveOptions, "metadata">): Promise<Playlist<T>>;
-    resolve<T = unknown>(song: string, options?: ResolveOptions<T>): Promise<Song<T> | Playlist<T>>;
-    resolve<T = unknown>(song: Song, options: ResolveOptions<T>): Promise<Song<T>>;
-    resolve<T = unknown>(song: Playlist, options: ResolveOptions<T>): Promise<Playlist<T>>;
-    resolve(song: string | Song | Playlist, options?: ResolveOptions): Promise<Song | Playlist>;
-    _getPluginFromURL(url: string): Promise<DisTubePlugin | null>;
-    _getPluginFromSong(song: Song): Promise<DisTubePlugin | null>;
-    _getPluginFromSong<T extends PluginType>(song: Song, types: T[], validate?: boolean): Promise<(DisTubePlugin & {
-        type: T;
-    }) | null>;
+    readonly id: Snowflake;
+    readonly voices: DisTubeVoiceManager;
+    readonly audioPlayer: AudioPlayer;
+    connection: VoiceConnection;
+    emittedError: boolean;
+    isDisconnected: boolean;
+    stream?: DisTubeStream;
+    pausingStream?: DisTubeStream;
+    constructor(voiceManager: DisTubeVoiceManager, channel: VoiceBasedChannel);
     /**
-     * Get {@link Song}'s stream info and attach it to the song.
-     * @param song - A Song
+     * The voice channel id the bot is in
      */
-    attachStreamInfo(song: Song): Promise<void>;
-    followRedirectLink(url: string, maxRedirect?: number): Promise<string>;
-}
-
-declare class Options {
-    #private;
-    plugins: DisTubePlugin[];
-    emitNewSongOnly: boolean;
-    savePreviousSongs: boolean;
-    customFilters?: Filters;
-    nsfw: boolean;
-    emitAddSongWhenCreatingQueue: boolean;
-    emitAddListWhenCreatingQueue: boolean;
-    joinNewVoiceChannel: boolean;
-    ffmpeg: FFmpegOptions;
-    constructor(options: DisTubeOptions);
+    get channelId(): string | undefined;
+    get channel(): VoiceBasedChannel;
+    set channel(channel: VoiceBasedChannel);
+    /**
+     * Join a voice channel with this connection
+     * @param channel - A voice channel
+     */
+    join(channel?: VoiceBasedChannel): Promise<DisTubeVoice>;
+    /**
+     * Leave the voice channel of this connection
+     * @param error - Optional, an error to emit with 'error' event.
+     */
+    leave(error?: Error): void;
+    /**
+     * Stop the playing stream
+     * @param force - If true, will force the {@link DisTubeVoice#audioPlayer} to enter the Idle state even
+     *                if the {@link DisTubeStream#audioResource} has silence padding frames.
+     */
+    stop(force?: boolean): void;
+    /**
+     * Play a {@link DisTubeStream}
+     * @param dtStream - DisTubeStream
+     */
+    play(dtStream: DisTubeStream): Promise<void>;
+    set volume(volume: number);
+    /**
+     * Get or set the volume percentage
+     */
+    get volume(): number;
+    /**
+     * Playback duration of the audio resource in seconds
+     */
+    get playbackDuration(): number;
+    pause(): void;
+    unpause(): void;
+    /**
+     * Whether the bot is self-deafened
+     */
+    get selfDeaf(): boolean;
+    /**
+     * Whether the bot is self-muted
+     */
+    get selfMute(): boolean;
+    /**
+     * Self-deafens/undeafens the bot.
+     * @param selfDeaf - Whether or not the bot should be self-deafened
+     * @returns true if the voice state was successfully updated, otherwise false
+     */
+    setSelfDeaf(selfDeaf: boolean): boolean;
+    /**
+     * Self-mutes/unmutes the bot.
+     * @param selfMute - Whether or not the bot should be self-muted
+     * @returns true if the voice state was successfully updated, otherwise false
+     */
+    setSelfMute(selfMute: boolean): boolean;
+    /**
+     * The voice state of this connection
+     */
+    get voiceState(): VoiceState | undefined;
 }
 
 /**
@@ -830,6 +708,31 @@ declare class DisTubeVoiceManager extends GuildIdManager<DisTubeVoice> {
     leave(guild: GuildIdResolvable): void;
 }
 
+/**
+ * Queue manager
+ */
+declare class QueueManager extends GuildIdManager<Queue> {
+    #private;
+    /**
+     * Create a {@link Queue}
+     * @param channel     - A voice channel
+     * @param textChannel - Default text channel
+     * @returns Returns `true` if encounter an error
+     */
+    create(channel: VoiceBasedChannel, textChannel?: GuildTextBasedChannel): Promise<Queue>;
+    /**
+     * Handle the queue when a Song finish
+     * @param queue - queue
+     */
+    handleSongFinish(queue: Queue): Promise<void>;
+    /**
+     * Play a song on voice connection with queue properties
+     * @param queue         - The guild queue to play
+     * @param emitPlaySong  - Whether or not emit {@link Events.PLAY_SONG} event
+     */
+    playSong(queue: Queue, emitPlaySong?: boolean): Promise<void>;
+}
+
 /**
  * Manage filters of a playing {@link Queue}
  */
@@ -878,23 +781,26 @@ declare class FilterManager extends BaseManager<Filter> {
 }
 
 /**
- * Queue manager
+ * Task queuing system
  */
-declare class QueueManager extends GuildIdManager<Queue> {
+declare class TaskQueue {
     #private;
     /**
-     * Create a {@link Queue}
-     * @param channel     - A voice channel
-     * @param textChannel - Default text channel
-     * @returns Returns `true` if encounter an error
+     * Waits for last task finished and queues a new task
      */
-    create(channel: VoiceBasedChannel, textChannel?: GuildTextBasedChannel): Promise<Queue>;
+    queuing(isPlay?: boolean): Promise<void>;
     /**
-     * Play a song on voice connection with queue properties
-     * @param queue         - The guild queue to play
-     * @param emitPlaySong  - Whether or not emit {@link Events.PLAY_SONG} event
+     * Removes the finished task and processes the next task
      */
-    playSong(queue: Queue, emitPlaySong?: boolean): Promise<void>;
+    resolve(): void;
+    /**
+     * The remaining number of tasks
+     */
+    get remaining(): number;
+    /**
+     * Whether or not having a play task
+     */
+    get hasPlayTask(): boolean;
 }
 
 /**
@@ -953,13 +859,9 @@ declare class Queue extends DisTubeBase {
      */
     _beginTime: number;
     /**
-     * Whether or not the last song was skipped to next song.
-     */
-    _next: boolean;
-    /**
-     * Whether or not the last song was skipped to previous song.
+     * Whether or not the queue is being updated manually (skip, jump, previous)
      */
-    _prev: boolean;
+    _manualUpdate: boolean;
     /**
      * Task queuing system
      */
@@ -1043,9 +945,10 @@ declare class Queue extends DisTubeBase {
      * 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 options - Skip options
      * @returns The song will skip to
      */
-    skip(): Promise<Song>;
+    skip(options?: JumpOptions): Promise<Song>;
     /**
      * Play the previous song if exists
      * @returns The guild queue
@@ -1061,9 +964,10 @@ declare class Queue extends DisTubeBase {
      * one is -1, -2,...
      * if `num` is invalid number
      * @param position - The song position to play
+     * @param options  - Skip options
      * @returns The new Song will be played
      */
-    jump(position: number): Promise<Song>;
+    jump(position: number, options?: JumpOptions): Promise<Song>;
     /**
      * Set the repeat mode of the guild queue.
      * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
@@ -1103,177 +1007,42 @@ declare class Queue extends DisTubeBase {
 }
 
 /**
- * DisTube Plugin
+ * DisTube class
  */
-declare abstract class Plugin {
+declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
+    #private;
     /**
-     * Type of the plugin
+     * @event
+     * Emitted after DisTube add a new playlist to the playing {@link Queue}.
+     * @param queue    - The guild queue
+     * @param playlist - Playlist info
      */
-    abstract readonly type: PluginType;
+    static readonly [Events.ADD_LIST]: (queue: Queue, playlist: Playlist) => Awaitable;
     /**
-     * DisTube
+     * @event
+     * Emitted after DisTube add a new song to the playing {@link Queue}.
+     * @param queue - The guild queue
+     * @param song  - Added song
      */
-    distube: DisTube;
-    init(distube: DisTube): void;
+    static readonly [Events.ADD_SONG]: (queue: Queue, song: Song) => Awaitable;
     /**
-     * Get related songs from a supported url.
-     * @param song - Input song
+     * @event
+     * Emitted when a {@link Queue} is deleted with any reasons.
+     * @param queue - The guild queue
      */
-    abstract getRelatedSongs(song: Song): Awaitable<Song[]>;
-}
-
-/**
- * This plugin can extract the info, search, and play a song directly from its source
- */
-declare abstract class ExtractorPlugin extends Plugin {
-    readonly type = PluginType.EXTRACTOR;
+    static readonly [Events.DELETE_QUEUE]: (queue: Queue) => Awaitable;
     /**
-     * Check if the url is working with this plugin
-     * @param url - Input url
+     * @event
+     * Emitted when the bot is disconnected to a voice channel.
+     * @param queue - The guild queue
      */
-    abstract validate(url: string): Awaitable<boolean>;
+    static readonly [Events.DISCONNECT]: (queue: Queue) => Awaitable;
     /**
-     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
-     * @param url     - URL
-     * @param options - Optional options
-     */
-    abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
-    /**
-     * Search for a Song which playable from this plugin's source
-     * @param query   - Search query
-     * @param options - Optional options
-     */
-    abstract searchSong<T>(query: string, options: ResolveOptions<T>): Awaitable<Song<T> | null>;
-    /**
-     * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
-     * Not needed if the plugin plays song from YouTube.
-     * @param song - Input song
-     */
-    abstract getStreamURL<T>(song: Song<T>): Awaitable<string>;
-}
-
-/**
- * This plugin only can extract the info from supported links, but not play song directly from its source
- */
-declare abstract class InfoExtractorPlugin extends Plugin {
-    readonly type = PluginType.INFO_EXTRACTOR;
-    /**
-     * Check if the url is working with this plugin
-     * @param url - Input url
-     */
-    abstract validate(url: string): Awaitable<boolean>;
-    /**
-     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
-     * @param url     - URL
-     * @param options - Optional options
-     */
-    abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
-    /**
-     * Create a search query to be used in {@link ExtractorPlugin#searchSong}
-     * @param song - Input song
-     */
-    abstract createSearchQuery<T>(song: Song<T>): Awaitable<string>;
-}
-
-/**
- * This plugin can extract and play song from supported links, but cannot search for songs from its source
- */
-declare abstract class PlayableExtractorPlugin extends Plugin {
-    readonly type = PluginType.PLAYABLE_EXTRACTOR;
-    /**
-     * Check if the url is working with this plugin
-     * @param url - Input url
-     */
-    abstract validate(url: string): Awaitable<boolean>;
-    /**
-     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
-     * @param url     - URL
-     * @param options - Optional options
-     */
-    abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
-    /**
-     * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
-     * Not needed if the plugin plays song from YouTube.
-     * @param song - Input song
-     */
-    abstract getStreamURL<T>(song: Song<T>): Awaitable<string>;
-}
-
-/**
- * Format duration to string
- * @param sec - Duration in seconds
- */
-declare function formatDuration(sec: number): string;
-declare const SUPPORTED_PROTOCOL: readonly ["https:", "http:", "file:"];
-/**
- * Check if the string is an URL
- * @param input - input
- */
-declare function isURL(input: any): input is `${(typeof SUPPORTED_PROTOCOL)[number]}//${string}`;
-/**
- * Check if the Client has enough intents to using DisTube
- * @param options - options
- */
-declare function checkIntents(options: ClientOptions): void;
-/**
- * Check if the voice channel is empty
- * @param voiceState - voiceState
- */
-declare function isVoiceChannelEmpty(voiceState: VoiceState): boolean;
-declare function isSnowflake(id: any): id is Snowflake;
-declare function isMemberInstance(member: any): member is GuildMember;
-declare function isTextChannelInstance(channel: any): channel is GuildTextBasedChannel;
-declare function isMessageInstance(message: any): message is Message<true>;
-declare function isSupportedVoiceChannel(channel: any): channel is VoiceBasedChannel;
-declare function isGuildInstance(guild: any): guild is Guild;
-declare function resolveGuildId(resolvable: GuildIdResolvable): Snowflake;
-declare function isClientInstance(client: any): client is Client;
-declare function checkInvalidKey(target: Record<string, any>, source: Record<string, any> | string[], sourceName: string): void;
-declare function isObject(obj: any): obj is object;
-type KeyOf<T> = T extends object ? (keyof T)[] : [];
-declare function objectKeys<T>(obj: T): KeyOf<T>;
-declare function isNsfwChannel(channel?: GuildTextBasedChannel): boolean;
-type Falsy = undefined | null | false | 0 | "";
-declare const isTruthy: <T>(x: T | Falsy) => x is T;
-declare const checkEncryptionLibraries: () => Promise<boolean>;
-
-/**
- * DisTube class
- */
-declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
-    #private;
-    /**
-     * @event
-     * Emitted after DisTube add a new playlist to the playing {@link Queue}.
-     * @param queue    - The guild queue
-     * @param playlist - Playlist info
-     */
-    static readonly [Events.ADD_LIST]: (queue: Queue, playlist: Playlist) => Awaitable;
-    /**
-     * @event
-     * Emitted after DisTube add a new song to the playing {@link Queue}.
-     * @param queue - The guild queue
-     * @param song  - Added song
-     */
-    static readonly [Events.ADD_SONG]: (queue: Queue, song: Song) => Awaitable;
-    /**
-     * @event
-     * Emitted when a {@link Queue} is deleted with any reasons.
-     * @param queue - The guild queue
-     */
-    static readonly [Events.DELETE_QUEUE]: (queue: Queue) => Awaitable;
-    /**
-     * @event
-     * Emitted when the bot is disconnected to a voice channel.
-     * @param queue - The guild queue
-     */
-    static readonly [Events.DISCONNECT]: (queue: Queue) => Awaitable;
-    /**
-     * @event
-     * Emitted when DisTube encounters an error while playing songs.
-     * @param error   - error
-     * @param queue   - The queue encountered the error
-     * @param song    - The playing song when encountered the error
+     * @event
+     * Emitted when DisTube encounters an error while playing songs.
+     * @param error   - error
+     * @param queue   - The queue encountered the error
+     * @param song    - The playing song when encountered the error
      */
     static readonly [Events.ERROR]: (error: Error, queue: Queue, song?: Song) => Awaitable;
     /**
@@ -1417,7 +1186,7 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      * @param guild - The type can be resolved to give a {@link Queue}
      * @returns The new Song will be played
      */
-    skip(guild: GuildIdResolvable): Promise<Song>;
+    skip(guild: GuildIdResolvable, options?: JumpOptions): Promise<Song>;
     /**
      * Play the previous song
      * @param guild - The type can be resolved to give a {@link Queue}
@@ -1437,7 +1206,7 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      * @param num   - The song number to play
      * @returns The new Song will be played
      */
-    jump(guild: GuildIdResolvable, num: number): Promise<Song>;
+    jump(guild: GuildIdResolvable, num: number, options?: JumpOptions): Promise<Song>;
     /**
      * Set the repeat mode of the guild queue.
      * Toggle mode `(Disabled -> Song -> Queue -> Disabled ->...)` if `mode` is `undefined`
@@ -1479,12 +1248,253 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
     debug(message: string): void;
 }
 
+declare abstract class DisTubeBase {
+    distube: DisTube;
+    constructor(distube: DisTube);
+    /**
+     * Emit the {@link DisTube} of this base
+     * @param eventName - Event name
+     * @param args      - arguments
+     */
+    emit(eventName: keyof DisTubeEvents, ...args: any): boolean;
+    /**
+     * Emit error event
+     * @param error   - error
+     * @param queue   - The queue encountered the error
+     * @param song    - The playing song when encountered the error
+     */
+    emitError(error: Error, queue: Queue, song?: Song): void;
+    /**
+     * Emit debug event
+     * @param message - debug message
+     */
+    debug(message: string): void;
+    /**
+     * The queue manager
+     */
+    get queues(): QueueManager;
+    /**
+     * The voice manager
+     */
+    get voices(): DisTubeVoiceManager;
+    /**
+     * Discord.js client
+     */
+    get client(): Client;
+    /**
+     * DisTube options
+     */
+    get options(): Options;
+    /**
+     * DisTube handler
+     */
+    get handler(): DisTubeHandler;
+    /**
+     * DisTube plugins
+     */
+    get plugins(): DisTubePlugin[];
+}
+
+declare const ERROR_MESSAGES: {
+    INVALID_TYPE: (expected: (number | string) | readonly (number | string)[], got: any, name?: string) => string;
+    NUMBER_COMPARE: (name: string, expected: string, value: number) => string;
+    EMPTY_ARRAY: (name: string) => string;
+    EMPTY_FILTERED_ARRAY: (name: string, type: string) => string;
+    EMPTY_STRING: (name: string) => string;
+    INVALID_KEY: (obj: string, key: string) => string;
+    MISSING_KEY: (obj: string, key: string) => string;
+    MISSING_KEYS: (obj: string, key: string[], all: boolean) => string;
+    MISSING_INTENTS: (i: string) => string;
+    DISABLED_OPTION: (o: string) => string;
+    ENABLED_OPTION: (o: string) => string;
+    NOT_IN_VOICE: string;
+    VOICE_FULL: string;
+    VOICE_ALREADY_CREATED: string;
+    VOICE_CONNECT_FAILED: (s: number) => string;
+    VOICE_MISSING_PERMS: string;
+    VOICE_RECONNECT_FAILED: string;
+    VOICE_DIFFERENT_GUILD: string;
+    VOICE_DIFFERENT_CLIENT: string;
+    FFMPEG_EXITED: (code: number) => string;
+    FFMPEG_NOT_INSTALLED: (path: string) => string;
+    ENCRYPTION_LIBRARIES_MISSING: string;
+    NO_QUEUE: string;
+    QUEUE_EXIST: string;
+    QUEUE_STOPPED: string;
+    PAUSED: string;
+    RESUMED: string;
+    NO_PREVIOUS: string;
+    NO_UP_NEXT: string;
+    NO_SONG_POSITION: string;
+    NO_PLAYING_SONG: string;
+    NO_EXTRACTOR_PLUGIN: string;
+    NO_RELATED: string;
+    CANNOT_PLAY_RELATED: string;
+    UNAVAILABLE_VIDEO: string;
+    UNPLAYABLE_FORMATS: string;
+    NON_NSFW: string;
+    NOT_SUPPORTED_URL: string;
+    NOT_SUPPORTED_SONG: (song: string) => string;
+    NO_VALID_SONG: string;
+    CANNOT_RESOLVE_SONG: (t: any) => string;
+    CANNOT_GET_STREAM_URL: (song: string) => string;
+    CANNOT_GET_SEARCH_QUERY: (song: string) => string;
+    NO_RESULT: (query: string) => string;
+    NO_STREAM_URL: (song: string) => string;
+    EMPTY_FILTERED_PLAYLIST: string;
+    EMPTY_PLAYLIST: string;
+};
+type ErrorMessage = typeof ERROR_MESSAGES;
+type ErrorCode = keyof ErrorMessage;
+type StaticErrorCode = {
+    [K in ErrorCode]-?: ErrorMessage[K] extends string ? K : never;
+}[ErrorCode];
+type TemplateErrorCode = Exclude<keyof typeof ERROR_MESSAGES, StaticErrorCode>;
+declare class DisTubeError<T extends string = any> extends Error {
+    errorCode: string;
+    constructor(code: T extends StaticErrorCode ? T : never);
+    constructor(code: T extends TemplateErrorCode ? T : never, ...args: Parameters<ErrorMessage[typeof code]>);
+    constructor(code: TemplateErrorCode, _: never);
+    constructor(code: T extends ErrorCode ? never : T, message: string);
+    get name(): string;
+    get code(): string;
+}
+
 /**
- * The current version that you are currently using.
- *
- * Note to developers:
- * This needs to explicitly be `string` so it is not typed as a "const string" that gets injected by esbuild
+ * DisTube Plugin
  */
-declare const version: string;
+declare abstract class Plugin {
+    /**
+     * Type of the plugin
+     */
+    abstract readonly type: PluginType;
+    /**
+     * DisTube
+     */
+    distube: DisTube;
+    init(distube: DisTube): void;
+    /**
+     * Get related songs from a supported url.
+     * @param song - Input song
+     */
+    abstract getRelatedSongs(song: Song): Awaitable<Song[]>;
+}
+
+/**
+ * This plugin can extract the info, search, and play a song directly from its source
+ */
+declare abstract class ExtractorPlugin extends Plugin {
+    readonly type = PluginType.EXTRACTOR;
+    /**
+     * Check if the url is working with this plugin
+     * @param url - Input url
+     */
+    abstract validate(url: string): Awaitable<boolean>;
+    /**
+     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
+     * @param url     - URL
+     * @param options - Optional options
+     */
+    abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
+    /**
+     * Search for a Song which playable from this plugin's source
+     * @param query   - Search query
+     * @param options - Optional options
+     */
+    abstract searchSong<T>(query: string, options: ResolveOptions<T>): Awaitable<Song<T> | null>;
+    /**
+     * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
+     * Not needed if the plugin plays song from YouTube.
+     * @param song - Input song
+     */
+    abstract getStreamURL<T>(song: Song<T>): Awaitable<string>;
+}
+
+/**
+ * This plugin only can extract the info from supported links, but not play song directly from its source
+ */
+declare abstract class InfoExtractorPlugin extends Plugin {
+    readonly type = PluginType.INFO_EXTRACTOR;
+    /**
+     * Check if the url is working with this plugin
+     * @param url - Input url
+     */
+    abstract validate(url: string): Awaitable<boolean>;
+    /**
+     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
+     * @param url     - URL
+     * @param options - Optional options
+     */
+    abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
+    /**
+     * Create a search query to be used in {@link ExtractorPlugin#searchSong}
+     * @param song - Input song
+     */
+    abstract createSearchQuery<T>(song: Song<T>): Awaitable<string>;
+}
+
+/**
+ * This plugin can extract and play song from supported links, but cannot search for songs from its source
+ */
+declare abstract class PlayableExtractorPlugin extends Plugin {
+    readonly type = PluginType.PLAYABLE_EXTRACTOR;
+    /**
+     * Check if the url is working with this plugin
+     * @param url - Input url
+     */
+    abstract validate(url: string): Awaitable<boolean>;
+    /**
+     * Resolve the validated url to a {@link Song} or a {@link Playlist}.
+     * @param url     - URL
+     * @param options - Optional options
+     */
+    abstract resolve<T>(url: string, options: ResolveOptions<T>): Awaitable<Song<T> | Playlist<T>>;
+    /**
+     * Get the stream url from {@link Song#url}. Returns {@link Song#url} by default.
+     * Not needed if the plugin plays song from YouTube.
+     * @param song - Input song
+     */
+    abstract getStreamURL<T>(song: Song<T>): Awaitable<string>;
+}
+
+/**
+ * Format duration to string
+ * @param sec - Duration in seconds
+ */
+declare function formatDuration(sec: number): string;
+declare const SUPPORTED_PROTOCOL: readonly ["https:", "http:", "file:"];
+/**
+ * Check if the string is an URL
+ * @param input - input
+ */
+declare function isURL(input: any): input is `${(typeof SUPPORTED_PROTOCOL)[number]}//${string}`;
+/**
+ * Check if the Client has enough intents to using DisTube
+ * @param options - options
+ */
+declare function checkIntents(options: ClientOptions): void;
+/**
+ * Check if the voice channel is empty
+ * @param voiceState - voiceState
+ */
+declare function isVoiceChannelEmpty(voiceState: VoiceState): boolean;
+declare function isSnowflake(id: any): id is Snowflake;
+declare function isMemberInstance(member: any): member is GuildMember;
+declare function isTextChannelInstance(channel: any): channel is GuildTextBasedChannel;
+declare function isMessageInstance(message: any): message is Message<true>;
+declare function isSupportedVoiceChannel(channel: any): channel is VoiceBasedChannel;
+declare function isGuildInstance(guild: any): guild is Guild;
+declare function resolveGuildId(resolvable: GuildIdResolvable): Snowflake;
+declare function isClientInstance(client: any): client is Client;
+declare function checkInvalidKey(target: Record<string, any>, source: Record<string, any> | string[], sourceName: string): void;
+declare function isObject(obj: any): obj is object;
+type KeyOf<T> = T extends object ? (keyof T)[] : [];
+declare function objectKeys<T>(obj: T): KeyOf<T>;
+declare function isNsfwChannel(channel?: GuildTextBasedChannel): boolean;
+type Falsy = undefined | null | false | 0 | "";
+declare const isTruthy: <T>(x: T | Falsy) => x is T;
+declare const checkEncryptionLibraries: () => Promise<boolean>;
 
-export { type Awaitable, BaseManager, type CustomPlaylistOptions, DisTube, DisTubeBase, DisTubeError, type DisTubeEvents, DisTubeHandler, type DisTubeOptions, type DisTubePlugin, DisTubeStream, DisTubeVoice, type DisTubeVoiceEvents, DisTubeVoiceManager, Events, ExtractorPlugin, type FFmpegArg, type FFmpegArgs, type FFmpegOptions, type Falsy, type Filter, FilterManager, type FilterResolvable, type Filters, GuildIdManager, type GuildIdResolvable, InfoExtractorPlugin, type KeyOf, Options, type PlayHandlerOptions, type PlayOptions, PlayableExtractorPlugin, Playlist, type PlaylistInfo, Plugin, PluginType, Queue, QueueManager, type RelatedSong, RepeatMode, type ResolveOptions, type ResolvePlaylistOptions, Song, type SongInfo, type StreamOptions, TaskQueue, type TypedDisTubeEvents, checkEncryptionLibraries, checkFFmpeg, checkIntents, checkInvalidKey, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isNsfwChannel, isObject, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isTruthy, isURL, isVoiceChannelEmpty, objectKeys, resolveGuildId, version };
+// @ts-ignore
+export = DisTube;
+export { type Awaitable, BaseManager, type CustomPlaylistOptions, DisTube, DisTubeBase, DisTubeError, type DisTubeEvents, DisTubeHandler, type DisTubeOptions, type DisTubePlugin, DisTubeStream, DisTubeVoice, type DisTubeVoiceEvents, DisTubeVoiceManager, Events, ExtractorPlugin, type FFmpegArg, type FFmpegArgs, type FFmpegOptions, type Falsy, type Filter, FilterManager, type FilterResolvable, type Filters, GuildIdManager, type GuildIdResolvable, InfoExtractorPlugin, type JumpOptions, type KeyOf, Options, type PlayHandlerOptions, type PlayOptions, PlayableExtractorPlugin, Playlist, type PlaylistInfo, Plugin, PluginType, Queue, QueueManager, type RelatedSong, RepeatMode, type ResolveOptions, type ResolvePlaylistOptions, Song, type SongInfo, type StreamOptions, TaskQueue, type TypedDisTubeEvents, checkEncryptionLibraries, checkFFmpeg, checkIntents, checkInvalidKey, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isNsfwChannel, isObject, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isTruthy, isURL, isVoiceChannelEmpty, objectKeys, resolveGuildId, version };