jericho-player/typings/Instances.d.ts

LightWeight Framework for discord.js v14 Music Bots and Radio Bots with fast moderation with commands and no memory leak mode

import {
  User,
  VoiceBasedChannel,
  Message,
  CommandInteraction,
  ButtonInteraction,
  SelectMenuInteraction,
} from "discord.js";
import { extractorData } from "playdl-music-extractor";

export type eventOptions = {
  ignoreCrash?: Boolean | true;
  emitPlayer?: Boolean | true;
  debugRegister?: Boolean | true;
};

export type downloaderOptions = {
  extractor?: string | "playdl";
  fetchLyrics?: Boolean | true;
  eventReturn?: { metadata?: any } | undefined;
  ratelimit?: Number | 0;
  ignoreInternalError?: Boolean | true;
  fetchOptions?: {
    tokens?: Object | {};
    rawCookies?: String;
    proxies?: String[];
    cookiesFile?: String;
    fetchLimit?: Number | "Infinity";
    streamQuality?: string | "high" | "medium" | "low" | undefined;
    userAgents?: string[];
    skipalbumLimit?: Boolean | true;
  };
};

export type voiceOptions = {
  eventOptions?: eventOptions;
  delayTimeout?: Number | 0;
  leaveOn?: {
    end?: number | Boolean | true | 0;
    empty?: number | Boolean | true | 0;
    bot?: number | Boolean | true | 0;
  };
  anyoneCanMoveClient?: Boolean | true;
  altVoiceChannel?: string | number | VoiceBasedChannel;
  forceDestroy?: Boolean | false;
};

export type packetOptions = {
  downloaderOptions?: downloaderOptions;
  voiceOptions?: voiceOptions;
  songQueryFilters?: String[] | ["all", "youtube", "spotify", "query"];
  noMemoryLeakMode: false;
};

export type Options = {
  eventOptions?: eventOptions;
  packetOption?: packetOptions;
};

export type TimeStamp = {
  currentTrack: {
    total: Number;
    now: Number;
    readable: String[];
  };
  previousTrack: {
    total: Number;
    readable: String[];
  };
  nextTrack: { total: Number; readable: String[] };
  queue: {
    total: Number;
    now: Number;
    readable: String[];
  };
  previousQueue: {
    total: Number;
    now: Number;
    readable: String[];
  };
  totalQueue: {
    total: Number;
    now: Number;
    readable: String[];
  };
};

export class Playlist {
  public readonly id: string | number;
  public readonly name: string;
  public readonly url: string;
  public readonly thumbnail: string;
  public readonly views: string | number | 0;
  public readonly tracksCount: number | 0;
  public readonly author: { name: string; url: string };
  public readonly extractorData: {
    orignal:
      | string
      | "deezer"
      | "youtube"
      | "spotify"
      | "facebook"
      | "reverbnation"
      | "soundcloud"
      | "arbitary";
    custom: string | "play-dl" | "youtube-dl";
  };
  public get raw(): object;
  public get requestedSource():
    | Message
    | CommandInteraction
    | ButtonInteraction
    | SelectMenuInteraction;
  public get user(): User;
  public get metadata(): object;
  public get type(): string | "playlist";
}
export class Track {
  public readonly id: string | number;
  public readonly videoId: string | number;
  public readonly playlistId: string | number | undefined;
  public readonly title: string;
  public readonly url: string;
  public readonly description: string;
  public readonly author: { name: string; url: string };
  public readonly views: string | number | 0;
  public readonly extractors: {
    orignal:
      | string
      | "deezer"
      | "youtube"
      | "spotify"
      | "facebook"
      | "reverbnation"
      | "soundcloud"
      | "arbitary";
    custom: string | "play-dl" | "youtube-dl";
  };
  public readonly thumbnail: {
    Id: string | number;
    url: string;
  };
  public readonly isLive: Boolean;
  public readonly duration: { ms: Number; readable: string };
  public readonly ratings: { likes: number; dislikes: number };
  public readonly playlist: Playlist;
  public readonly extractorData: extractorData;
  public readonly lyrics: string;
  public get raw(): object;
  public get requestedSource():
    | Message
    | CommandInteraction
    | ButtonInteraction
    | SelectMenuInteraction;
  public get user(): User;
  public get metadata(): object;
  public get type(): string | "track";
}

export type Awaitable<T> = T | PromiseLike<T>;