distube 3.0.0-beta.8 → 3.0.2

package/typings/DisTubeHandler.d.ts

@@ -1,130 +0,0 @@
-export = DisTubeHandler;
-/**
- * DisTube's Handler
- * @extends DisTubeBase
- * @private
- */
-declare class DisTubeHandler extends DisTubeBase {
-    constructor(distube: any);
-    ytdlOptions: any;
-    /**
-     * Emit error event
-     * @param {Discord.TextChannel} channel Text channel where the error is encountered.
-     * @param {Error} error error
-     * @private
-     */
-    private emitError;
-    /**
-     * Delete a guild queue
-     * @param {Discord.Snowflake|Discord.Message|Queue} queue A message from guild channel | Queue
-     */
-    deleteQueue(queue: Discord.Snowflake | Discord.Message | Queue): void;
-    /**
-     * @param {string} url url
-     * @returns {Promise<ytdl.videoInfo>}
-     */
-    getYouTubeInfo(url: string): Promise<any>;
-    /**
-     * Resolve a Song
-     * @param {Discord.Message|Discord.GuildMember} message A message from guild channel | A guild member
-     * @param {string|Song|SearchResult|Playlist} song YouTube url | Search string | {@link Song}
-     * @returns {Promise<Song|Array<Song>|Playlist>} Resolved Song
-     */
-    resolveSong(message: Discord.Message | Discord.GuildMember, song: string | Song | SearchResult | Playlist): Promise<Song | Array<Song> | Playlist>;
-    /**
-     * Resole Song[] or url to a Playlist
-     * @param {Discord.Message|Discord.GuildMember} message A message from guild channel | A guild member
-     * @param {Array<Song>|string} playlist Resolvable playlist
-     * @returns {Promise<Playlist>}
-     */
-    resolvePlaylist(message: Discord.Message | Discord.GuildMember, playlist: Array<Song> | string): Promise<Playlist>;
-    /**
-     * Create a custom playlist
-     * @returns {Promise<Playlist>}
-     * @param {Discord.Message|Discord.GuildMember} message A message from guild channel | A guild member
-     * @param {Array<string|Song|SearchResult>} songs Array of url, Song or SearchResult
-     * @param {Object} [properties={}] Additional properties such as `name`
-     * @param {boolean} [parallel=true] Whether or not fetch the songs in parallel
-     */
-    createCustomPlaylist(message: Discord.Message | Discord.GuildMember, songs: Array<string | Song | SearchResult>, properties?: any, parallel?: boolean): Promise<Playlist>;
-    /**
-     * Play / add a playlist
-     * @returns {Promise<void>}
-     * @param {Discord.Message|Discord.VoiceChannel|Discord.StageChannel} message A message from guild channel | a voice channel
-     * @param {Playlist|string} playlist A YouTube playlist url | a Playlist
-     * @param {boolean} [textChannel] The default text channel of the queue
-     * @param {boolean} [skip=false] Skip the current song
-     */
-    handlePlaylist(message: Discord.Message | Discord.VoiceChannel | Discord.StageChannel, playlist: Playlist | string, textChannel?: boolean, skip?: boolean): Promise<void>;
-    /**
-     * Search for a song, fire {@link DisTube#event:error} if not found.
-     * @param {Discord.Message} message A message from guild channel
-     * @param {string} query The query string
-     * @returns {Promise<Song?>} Song info
-     */
-    searchSong(message: Discord.Message, query: string): Promise<Song | null>;
-    /**
-     * Join the voice channel
-     * @param {Queue} queue A message from guild channel
-     * @param {Discord.VoiceChannel|Discord.StageChannel} voice The string search for
-     * @param {boolean} retried retried?
-     * @throws {Error}
-     * @returns {Promise<Queue|true>} `true` if queue is not generated
-     */
-    joinVoiceChannel(queue: Queue, voice: Discord.VoiceChannel | Discord.StageChannel, retried?: boolean): Promise<Queue | true>;
-    /**
-     * Get related songs
-     * @param {Song} song song
-     * @returns {Array<ytdl.relatedVideo>} Related videos
-     * @throws {NoRelated}
-     */
-    getRelatedVideo(song: Song): Array<any>;
-    /**
-     * Create a ytdl stream
-     * @param {Queue} queue Queue
-     * @returns {opus.Encoder}
-     */
-    createStream(queue: Queue): opus.Encoder;
-    checkYouTubeInfo(song: any): Promise<void>;
-    /**
-     * Whether or not emit playSong event
-     * @param {Queue} queue Queue
-     * @private
-     * @returns {boolean}
-     */
-    private _emitPlaySong;
-    /**
-     * Play a song on voice connection
-     * @param {Queue} queue The guild queue
-     * @returns {Promise<boolean>} error?
-     */
-    playSong(queue: Queue): Promise<boolean>;
-    /**
-     * Handle the queue when a Song finish
-     * @private
-     * @param {Queue} queue queue
-     * @returns {Promise<void>}
-     */
-    private _handleSongFinish;
-    /**
-     * Handle error while playing
-     * @private
-     * @param {Queue} queue queue
-     * @param {Error} error error
-     */
-    private _handlePlayingError;
-    /**
-     * Play a song from url without creating a {@link Queue}
-     * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined
-     * @param {string|Song|SearchResult} song YouTube url | {@link Song} | {@link SearchResult}
-     * @returns {Promise<Discord.StreamDispatcher>}
-     */
-    playWithoutQueue(voiceChannel: Discord.VoiceChannel | Discord.StageChannel, song: string | Song | SearchResult): Promise<Discord.StreamDispatcher>;
-}
-import DisTubeBase = require("./DisTubeBase");
-import Discord = require("discord.js");
-import Queue = require("./Queue");
-import Song = require("./Song");
-import SearchResult = require("./SearchResult");
-import Playlist = require("./Playlist");
-import { opus } from "prism-media";

package/typings/DisTubeOptions.d.ts

@@ -1,5 +0,0 @@
-export = DisTubeOptions;
-declare class DisTubeOptions {
-    constructor(options: any);
-    _validateOptions(options?: import("./DisTubeOptions")): void;
-}

package/typings/Filter.d.ts

@@ -1,83 +0,0 @@
-declare const _exports: {
-    "3d": string;
-    bassboost: string;
-    echo: string;
-    flanger: string;
-    gate: string;
-    haas: string;
-    karaoke: string;
-    nightcore: string;
-    reverse: string;
-    vaporwave: string;
-    mcompand: string;
-    phaser: string;
-    tremolo: string;
-    surround: string;
-    earwax: string;
-};
-export = _exports;
-/**
- * Default DisTube audio filters.
- */
-export type DefaultFilters = {
-    /**
-     * 3d 3d
-     */
-    "": string;
-    /**
-     * bassboost
-     */
-    bassboost: string;
-    /**
-     * echo
-     */
-    echo: string;
-    /**
-     * karaoke
-     */
-    karaoke: string;
-    /**
-     * nightcore
-     */
-    nightcore: string;
-    /**
-     * vaporwave
-     */
-    vaporwave: string;
-    /**
-     * flanger
-     */
-    flanger: string;
-    /**
-     * gate
-     */
-    gate: string;
-    /**
-     * haas
-     */
-    haas: string;
-    /**
-     * reverse
-     */
-    reverse: string;
-    /**
-     * surround
-     */
-    surround: string;
-    /**
-     * mcompand
-     */
-    mcompand: string;
-    /**
-     * phaser
-     */
-    phaser: string;
-    /**
-     * tremolo
-     */
-    tremolo: string;
-    /**
-     * earwax
-     */
-    earwax: string;
-};

package/typings/Playlist.d.ts

@@ -1,58 +0,0 @@
-export = Playlist;
-/** Class representing a playlist. */
-declare class Playlist {
-    /**
-     * Create a playlist
-     * @param {Array<Song>|Object} playlist Playlist
-     * @param {Discord.GuildMember} member Requested user
-     * @param {Object} properties Custom properties
-     */
-    constructor(playlist: Array<Song> | any, member: Discord.GuildMember, properties?: any);
-    /**
-     * The source of the playlist
-     * @type {string}
-     */
-    source: string;
-    /**
-     * User requested.
-     * @type {Discord.GuildMember}
-     */
-    member: Discord.GuildMember;
-    /**
-     * User requested.
-     * @type {Discord.User}
-     */
-    user: Discord.User;
-    /**
-     * Playlist songs.
-     * @type {Array<Song>}
-     */
-    songs: Array<Song>;
-    /**
-     * Playlist name.
-     * @type {string}
-     */
-    name: string;
-    /**
-     * Playlist URL.
-     * @type {string}
-     */
-    url: string;
-    /**
-     * Playlist thumbnail.
-     * @type {string}
-     */
-    thumbnail: string;
-    /**
-     * Playlist duration in second.
-     * @type {number}
-     */
-    get duration(): number;
-    /**
-     * Formatted duration string `hh:mm:ss`.
-     * @type {string}
-     */
-    get formattedDuration(): string;
-}
-import Discord = require("discord.js");
-import Song = require("./Song");

package/typings/Plugin/CustomPlugin.d.ts

@@ -1,21 +0,0 @@
-export = CustomPlugin;
-/**
- * Custom Plugin
- * @extends Plugin
-*/
-declare class CustomPlugin extends Plugin {
-    /** Create a custom plugin */
-    constructor();
-    /**
-     * Execute if the url is validated
-     * @param {Discord.VoiceChannel|Discord.StageChannel} voiceChannel The voice channel will be joined
-     * @param {string} url Validated url
-     * @param {Discord.GuildMember} member Requested user
-     * @param {Discord.TextChannel?} textChannel Default {@link Queue#textChannel}
-     * @param {boolean} skip Skip the playing song (if exists)
-     * @returns {Promise<void>}
-     */
-    play(voiceChannel: Discord.VoiceChannel | Discord.StageChannel, url: string, member: Discord.GuildMember, textChannel: Discord.TextChannel | null, skip: boolean): Promise<void>;
-}
-import Plugin = require("./Plugin");
-import Discord = require("discord.js");

package/typings/Plugin/ExtractorPlugin.d.ts

@@ -1,20 +0,0 @@
-export = ExtractorPlugin;
-/**
- * Extractor Plugin
- * @extends Plugin
- */
-declare class ExtractorPlugin extends Plugin {
-    /** Create a extractor plugin */
-    constructor();
-    /**
-     * Execute if the url is validated
-     * @param {string} url URL
-     * @param {Discord.GuildMember} member Requested user
-     * @returns {Promise<Song|Song[]|Playlist>}
-     */
-    resolve(url: string, member: Discord.GuildMember): Promise<Song | Song[] | Playlist>;
-}
-import Plugin = require("./Plugin");
-import Discord = require("discord.js");
-import Song = require("../Song");
-import Playlist = require("../Playlist");

package/typings/Plugin/Plugin.d.ts

@@ -1,31 +0,0 @@
-export = Plugin;
-/**
- * DisTube Plugin
- * @private
- */
-declare class Plugin {
-    constructor(type: any);
-    /**
-     * Type of plugin (`"custom"` | `"extractor"`)
-     * @type {string}
-     */
-    type: string;
-    init(distube: any): void;
-    /**
-     * DisTube
-     * @type {DisTube}
-     */
-    distube: DisTube;
-    /**
-     * Handler
-     * @type {DisTubeHandler}
-     */
-    handler: any;
-    /**
-     * Check if the url is working with this plugin
-     * @param {string} url Input url
-     * @returns {Promise<boolean>}
-     */
-    validate(url: string): Promise<boolean>;
-}
-import DisTube = require("../DisTube");

package/typings/Plugin/http.d.ts

@@ -1,4 +0,0 @@
-export = HTTPPlugin;
-declare const HTTPPlugin_base: typeof import("./ExtractorPlugin");
-declare class HTTPPlugin extends HTTPPlugin_base {
-}

package/typings/Plugin/https.d.ts

@@ -1,4 +0,0 @@
-export = HTTPSPlugin;
-declare const HTTPSPlugin_base: typeof import("./ExtractorPlugin");
-declare class HTTPSPlugin extends HTTPSPlugin_base {
-}

package/typings/Queue.d.ts

@@ -1,227 +0,0 @@
-export = Queue;
-/**
- * Represents a queue.
- * @extends DisTubeBase
- */
-declare class Queue extends DisTubeBase {
-    constructor(distube: any, message: any, song: any, textChannel?: any);
-    /**
-     * Queue id (Guild id)
-     * @type {Discord.Snowflake}
-     */
-    id: Discord.Snowflake;
-    /**
-     * Stream dispatcher.
-     * @type {Discord.StreamDispatcher?}
-     */
-    dispatcher: Discord.StreamDispatcher | null;
-    /**
-     * Voice connection.
-     * @type {Discord.VoiceConnection?}
-     */
-    connection: Discord.VoiceConnection | null;
-    /**
-     * Stream volume. Default value: `50`.
-     * @type {number}
-     */
-    volume: number;
-    /**
-     * List of songs in the queue (The first one is the playing song)
-     * @type {Array<Song>}
-     */
-    songs: Array<Song>;
-    /**
-     * List of the previous songs.
-     * @type {Array<Song>?}
-     */
-    previousSongs: Array<Song> | null;
-    /**
-     * Whether stream is currently stopped.
-     * @type {boolean}
-     * @private
-     */
-    private stopped;
-    /**
-     * Whether or not the last song was skipped to next song.
-     * @type {boolean}
-     * @private
-     */
-    private next;
-    /**
-     * Whether or not the last song was skipped to previous song.
-     * @type {boolean}
-     * @private
-     */
-    private prev;
-    /**
-     * Whether or not the stream is currently playing.
-     * @type {boolean}
-     */
-    playing: boolean;
-    /**
-     * Whether or not the stream is currently paused.
-     * @type {boolean}
-     */
-    paused: boolean;
-    /**
-     * Type of repeat mode (`0` is disabled, `1` is repeating a song, `2` is repeating all the queue).
-     * Default value: `0` (disabled)
-     * @type {number}
-     */
-    repeatMode: number;
-    /**
-     * Whether or not the autoplay mode is enabled.
-     * Default value: `false`
-     * @type {boolean}
-     */
-    autoplay: boolean;
-    /**
-     * Enabled audio filters.
-     * Available filters: {@link Filters}
-     * @type {Array<string>}
-     */
-    filters: Array<string>;
-    /**
-     * Should be an opus stream
-     * @type {Readable?}
-     * @private
-     */
-    private stream;
-    /**
-     * What time in the song to begin (in seconds).
-     * @type {number}
-     */
-    beginTime: number;
-    /**
-     * The text channel of the Queue. (Default: where the first command is called).
-     * @type {Discord.TextChannel?}
-     */
-    textChannel: Discord.TextChannel | null;
-    /**
-     * @type {DisTubeHandler}
-     * @private
-     */
-    private handler;
-    /**
-     * Timeout for checking empty channel
-     * @type {NodeJS.Timeout?}
-     * @private
-     */
-    private emptyTimeout;
-    /**
-     * 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}
-     */
-    get voiceChannel(): Discord.VoiceChannel | Discord.StageChannel;
-    /**
-     * Add a Song or an array of Song to the queue
-     * @param {Song|Array<Song>} song Song to add
-     * @param {boolean} [unshift=false] Unshift?
-     * @throws {Error}
-     * @returns {Queue}
-     */
-    addToQueue(song: Song | Array<Song>, unshift?: boolean): Queue;
-    /**
-     * Pause the guild stream
-     * @returns {Queue} The guild queue
-     */
-    pause(): Queue;
-    /**
-     * Resume the guild stream
-     * @returns {Queue} The guild queue
-     */
-    resume(): Queue;
-    /**
-     * Stop the guild stream
-     */
-    stop(): void;
-    /**
-     * 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
-     * @returns {Song} The song will skip to
-     * @throws {Error}
-     */
-    skip(): Song;
-    /**
-     * Play the previous song
-     * @returns {Song} The guild queue
-     * @throws {Error}
-     */
-    previous(): Song;
-    /**
-     * Shuffle the queue's songs
-     * @returns {Queue} The guild queue
-     */
-    shuffle(): Queue;
-    /**
-     * Jump to the song number in the queue.
-     * The next one is 1, 2,...
-     * The previous one is -1, -2,...
-     * @param {number} num The song number to play
-     * @returns {Queue} The guild queue
-     * @throws {InvalidSong} if `num` is invalid number (0 < num < {@link Queue#songs}.length)
-     */
-    jump(num: number): Queue;
-    /**
-     * Set the repeat mode of the guild queue.
-     * Turn off if repeat mode is the same value as new mode.
-     * Toggle mode: `mode = null` `(0 -> 1 -> 2 -> 0...)`
-     * @param {number?} [mode] The repeat modes `(0: disabled, 1: Repeat a song, 2: Repeat all the queue)`
-     * @returns {number} The new repeat mode
-     */
-    setRepeatMode(mode?: number | null): number;
-    /**
-     * Enable or disable filter of the queue.
-     * Available filters: {@link Filters}
-     * @param {string|false} filter A filter name, `false` to clear all the filters
-     * @returns {Array<string>} Enabled filters.
-     * @throws {Error}
-     */
-    setFilter(filter: string | false): Array<string>;
-    /**
-     * Set the playing time to another position
-     * @param {number} time Time in seconds
-     * @returns {Queue}
-     */
-    seek(time: number): Queue;
-    /**
-     * Add a related song to the queue
-     * @param {Song} [song] A song to get the related one
-     * @returns {Promise<Queue>} The guild queue
-     * @throws {Error}
-     */
-    addRelatedVideo(song?: Song): Promise<Queue>;
-    /**
-     * Toggle autoplay mode
-     * @returns {boolean} Autoplay mode state
-     */
-    toggleAutoplay(): boolean;
-}
-import DisTubeBase = require("./DisTubeBase");
-import Discord = require("discord.js");
-import Song = require("./Song");

package/typings/SearchResult.d.ts

@@ -1,51 +0,0 @@
-export = SearchResult;
-/** Class representing a search result. */
-declare class SearchResult {
-    constructor(info: any);
-    source: string;
-    /**
-     * Type of SearchResult (video or playlist)
-     * @type {string}
-     */
-    type: string;
-    /**
-     * YouTube video or playlist id
-     * @type {string}
-     */
-    id: string;
-    /**
-     * Video or playlist title.
-     * @type {string}
-     */
-    name: string;
-    /**
-     * Video or playlist URL.
-     * @type {string}
-     */
-    url: string;
-    /**
-     * Video / Playlist views count
-     * @type {number}
-     */
-    views: number;
-    /**
-     * Indicates if the video is an active live.
-     * @type {boolean?}
-     */
-    isLive: boolean | null;
-    /**
-     * Video duration.
-     * @type {number}
-     */
-    duration: number;
-    /**
-     * Formatted duration string `hh:mm:ss` or `mm:ss`.
-     * @type {string}
-     */
-    formattedDuration: string;
-    /**
-     * Video thumbnail.
-     * @type {string?}
-     */
-    thumbnail: string | null;
-}