lavalink-client 1.1.6 → 1.1.7

package/dist/cjs/structures/Queue.d.ts

@@ -18,8 +18,11 @@ export interface QueueStoreManager extends Record<string, any> {
     parse: (value: unknown) => Promise<Partial<StoredQueue>>;
 }
 export interface ManagerQueueOptions {
+    /** Maximum Amount of tracks for the queue.previous array */
     maxPreviousTracks?: number;
+    /** Custom Queue Store option */
     queueStore?: QueueStoreManager;
+    /** Custom Queue Watcher class */
     queueChangesWatcher?: QueueChangesWatcher;
 }
 export interface QueueSaver {

package/dist/cjs/structures/Track.d.ts

@@ -1,30 +1,53 @@
 import { Player } from "./Player";
 import { Base64 } from "./Utils";
-type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
-type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
-type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
+/** Sourcenames provided by lavalink server */
+export type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
+/** Source Names provided by lava src plugin */
+export type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
+/** The SourceNames provided by lavalink */
+export type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
 export interface LavalinkTrackInfo {
+    /** The Identifier of the Track */
     identifier: string;
+    /** The Track Title / Name */
     title: string;
+    /** The Name of the Author */
     author: string;
+    /** The duration of the Track */
     length: number;
+    /** The URL of the artwork if available */
     artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
     uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
     sourceName: SourceNames;
+    /** Wether the audio is seekable */
     isSeekable: boolean;
+    /** Wether the audio is of a live stream */
     isStream: boolean;
+    /** If isrc code is available, it's provided */
     isrc: string | null;
 }
 export interface TrackInfo {
+    /** The Identifier of the Track */
     identifier: string;
+    /** The Track Title / Name */
     title: string;
+    /** The Name of the Author */
     author: string;
+    /** The duration of the Track */
     duration: number;
+    /** The URL of the artwork if available */
     artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
     uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
     sourceName: SourceNames;
+    /** Wether the audio is seekable */
     isSeekable: boolean;
+    /** Wether the audio is of a live stream */
     isStream: boolean;
+    /** If isrc code is available, it's provided */
     isrc: string | null;
 }
 export interface PluginInfo {
@@ -95,4 +118,3 @@ export interface UnresolvedTrack {
     /** The Track's Requester */
     requester?: unknown;
 }
-export {};

package/dist/cjs/structures/Utils.d.ts

@@ -119,7 +119,7 @@ export declare class MiniMap<K, V> extends Map<K, V> {
     filter<This, K2 extends K>(fn: (this: This, value: V, key: K, miniMap: this) => key is K2, thisArg: This): MiniMap<K2, V>;
     filter<This, V2 extends V>(fn: (this: This, value: V, key: K, miniMap: this) => value is V2, thisArg: This): MiniMap<K, V2>;
     filter<This>(fn: (this: This, value: V, key: K, miniMap: this) => boolean, thisArg: This): MiniMap<K, V>;
-    toJSON(): V[];
+    toJSON(): [K, V][];
     /**
      * Maps each item to another value into an array. Identical in behavior to
      * [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).

package/dist/cjs/structures/Utils.js

@@ -256,8 +256,7 @@ class MiniMap extends Map {
         return results;
     }
     toJSON() {
-        // toJSON is called recursively by JSON.stringify.
-        return [...this.values()];
+        return [...this.entries()];
     }
     map(fn, thisArg) {
         if (typeof thisArg !== 'undefined')

package/dist/esm/structures/Queue.d.ts

@@ -18,8 +18,11 @@ export interface QueueStoreManager extends Record<string, any> {
     parse: (value: unknown) => Promise<Partial<StoredQueue>>;
 }
 export interface ManagerQueueOptions {
+    /** Maximum Amount of tracks for the queue.previous array */
     maxPreviousTracks?: number;
+    /** Custom Queue Store option */
     queueStore?: QueueStoreManager;
+    /** Custom Queue Watcher class */
     queueChangesWatcher?: QueueChangesWatcher;
 }
 export interface QueueSaver {

package/dist/esm/structures/Track.d.ts

@@ -1,30 +1,53 @@
 import { Player } from "./Player";
 import { Base64 } from "./Utils";
-type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
-type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
-type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
+/** Sourcenames provided by lavalink server */
+export type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
+/** Source Names provided by lava src plugin */
+export type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
+/** The SourceNames provided by lavalink */
+export type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
 export interface LavalinkTrackInfo {
+    /** The Identifier of the Track */
     identifier: string;
+    /** The Track Title / Name */
     title: string;
+    /** The Name of the Author */
     author: string;
+    /** The duration of the Track */
     length: number;
+    /** The URL of the artwork if available */
     artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
     uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
     sourceName: SourceNames;
+    /** Wether the audio is seekable */
     isSeekable: boolean;
+    /** Wether the audio is of a live stream */
     isStream: boolean;
+    /** If isrc code is available, it's provided */
     isrc: string | null;
 }
 export interface TrackInfo {
+    /** The Identifier of the Track */
     identifier: string;
+    /** The Track Title / Name */
     title: string;
+    /** The Name of the Author */
     author: string;
+    /** The duration of the Track */
     duration: number;
+    /** The URL of the artwork if available */
     artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
     uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
     sourceName: SourceNames;
+    /** Wether the audio is seekable */
     isSeekable: boolean;
+    /** Wether the audio is of a live stream */
     isStream: boolean;
+    /** If isrc code is available, it's provided */
     isrc: string | null;
 }
 export interface PluginInfo {
@@ -95,4 +118,3 @@ export interface UnresolvedTrack {
     /** The Track's Requester */
     requester?: unknown;
 }
-export {};

package/dist/esm/structures/Utils.d.ts

@@ -119,7 +119,7 @@ export declare class MiniMap<K, V> extends Map<K, V> {
     filter<This, K2 extends K>(fn: (this: This, value: V, key: K, miniMap: this) => key is K2, thisArg: This): MiniMap<K2, V>;
     filter<This, V2 extends V>(fn: (this: This, value: V, key: K, miniMap: this) => value is V2, thisArg: This): MiniMap<K, V2>;
     filter<This>(fn: (this: This, value: V, key: K, miniMap: this) => boolean, thisArg: This): MiniMap<K, V>;
-    toJSON(): V[];
+    toJSON(): [K, V][];
     /**
      * Maps each item to another value into an array. Identical in behavior to
      * [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).

package/dist/esm/structures/Utils.js

@@ -252,8 +252,7 @@ export class MiniMap extends Map {
         return results;
     }
     toJSON() {
-        // toJSON is called recursively by JSON.stringify.
-        return [...this.values()];
+        return [...this.entries()];
     }
     map(fn, thisArg) {
         if (typeof thisArg !== 'undefined')

package/dist/types/structures/Queue.d.ts

@@ -18,8 +18,11 @@ export interface QueueStoreManager extends Record<string, any> {
     parse: (value: unknown) => Promise<Partial<StoredQueue>>;
 }
 export interface ManagerQueueOptions {
+    /** Maximum Amount of tracks for the queue.previous array */
     maxPreviousTracks?: number;
+    /** Custom Queue Store option */
     queueStore?: QueueStoreManager;
+    /** Custom Queue Watcher class */
     queueChangesWatcher?: QueueChangesWatcher;
 }
 export interface QueueSaver {

package/dist/types/structures/Track.d.ts

@@ -1,30 +1,53 @@
 import { Player } from "./Player";
 import { Base64 } from "./Utils";
-type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
-type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
-type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
+/** Sourcenames provided by lavalink server */
+export type LavalinkSourceNames = "youtube" | "youtubemusic" | "soundcloud" | "bandcamp" | "twitch";
+/** Source Names provided by lava src plugin */
+export type LavalinkPlugin_LavaSrc_SourceNames = "deezer" | "spotify" | "applemusic" | "yandexmusic" | "flowery-tts";
+/** The SourceNames provided by lavalink */
+export type SourceNames = LavalinkSourceNames | LavalinkPlugin_LavaSrc_SourceNames;
 export interface LavalinkTrackInfo {
+    /** The Identifier of the Track */
     identifier: string;
+    /** The Track Title / Name */
     title: string;
+    /** The Name of the Author */
     author: string;
+    /** The duration of the Track */
     length: number;
+    /** The URL of the artwork if available */
     artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
     uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
     sourceName: SourceNames;
+    /** Wether the audio is seekable */
     isSeekable: boolean;
+    /** Wether the audio is of a live stream */
     isStream: boolean;
+    /** If isrc code is available, it's provided */
     isrc: string | null;
 }
 export interface TrackInfo {
+    /** The Identifier of the Track */
     identifier: string;
+    /** The Track Title / Name */
     title: string;
+    /** The Name of the Author */
     author: string;
+    /** The duration of the Track */
     duration: number;
+    /** The URL of the artwork if available */
     artworkUrl: string | null;
+    /** The URL (aka Link) of the Track called URI */
     uri: string;
+    /** The Source name of the Track, e.g. soundcloud, youtube, spotify */
     sourceName: SourceNames;
+    /** Wether the audio is seekable */
     isSeekable: boolean;
+    /** Wether the audio is of a live stream */
     isStream: boolean;
+    /** If isrc code is available, it's provided */
     isrc: string | null;
 }
 export interface PluginInfo {
@@ -95,4 +118,3 @@ export interface UnresolvedTrack {
     /** The Track's Requester */
     requester?: unknown;
 }
-export {};

package/dist/types/structures/Utils.d.ts

@@ -119,7 +119,7 @@ export declare class MiniMap<K, V> extends Map<K, V> {
     filter<This, K2 extends K>(fn: (this: This, value: V, key: K, miniMap: this) => key is K2, thisArg: This): MiniMap<K2, V>;
     filter<This, V2 extends V>(fn: (this: This, value: V, key: K, miniMap: this) => value is V2, thisArg: This): MiniMap<K, V2>;
     filter<This>(fn: (this: This, value: V, key: K, miniMap: this) => boolean, thisArg: This): MiniMap<K, V>;
-    toJSON(): V[];
+    toJSON(): [K, V][];
     /**
      * Maps each item to another value into an array. Identical in behavior to
      * [Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lavalink-client",
-  "version": "1.1.6",
+  "version": "1.1.7",
   "description": "Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",