lavalink-client 2.2.0 → 2.2.2

package/README.md

@@ -2,7 +2,7 @@
 Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients.
 
 <div align="center">
-  <p> 
+  <p>
     <img src="https://madewithlove.now.sh/at?heart=true&template=for-the-badge" alt="Made with love in Austria">
     <img alt="Made with TypeScript" src="https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white">
   </p>
@@ -59,6 +59,8 @@ yarn add tomato6966/lavalink-client
 
 Check out the [Documentation](https://lc4.gitbook.io/lavalink-client) | or the [TSDocumentation](https://tomato6966.github.io/lavalink-client/) for **Examples**, and **__detailled__ Docs**, and to figure out **how to get started**. *note: it's not fully done yet (see the docs)*
 
+- __**INFO Note**__: Please use the **[TSDocumentation (auto generated, folder `/tsDocs`)](https://tomato6966.github.io/lavalink-client/)** to get the entire information of lavalink-client, *I don't have time to update the [custom written gitbook-documentation](https://lc4.gitbook.io/lavalink-client) (folder `/docs`, feel free to update it)*
+
 # Used in:
 
 - [Betty](https://betty.cx/)
@@ -73,7 +75,7 @@ Check out the [Documentation](https://lc4.gitbook.io/lavalink-client) | or the [
 
 - ✨ Choose able queue stores (maps, collections, redis, databases, ...)
   - You can create your own queueStore, thus make it easy to sync queues accross multiple connections (e.g. dashboard-bot)
-  - Automated Queue Sync methods 
+  - Automated Queue Sync methods
   - Automated unresolveable Tracks (save the queries as Partial Track Objects -> Fetch the tracks only once they are gonna play)
 
 - 😍 Included Filter & Equalizer Management
@@ -89,20 +91,20 @@ Check out the [Documentation](https://lc4.gitbook.io/lavalink-client) | or the [
 
 - 🛡️ Client Validations
   - Allows you to whitelist links and even blacklist links / words / domain names, so that it doesn't allow requests you don't want!
-  - Checks almost all Lavalink Requests for out of bound errors, right before the request is made to prevent process breaking errors. 
+  - Checks almost all Lavalink Requests for out of bound errors, right before the request is made to prevent process breaking errors.
 
 - 🧑‍💻 Memory friendly and easy style
   - Only the required data is displayed, and the store-way & types match Lavalink#IMPLEMENTATION.md
 
 - 😘 Automated Handlings
-  - Skips the songs, on TrackEnd, TrackStuck, TrackError, 
+  - Skips the songs, on TrackEnd, TrackStuck, TrackError,
   - Destroys the player on channeldelete
   - Pauses / resumes the player if it get's muted / unmuted (server-wide) [soon]
   - ...
 
 - 😁 Much much more!
 
-*** 
+***
 
 # All Events:
 
@@ -167,10 +169,10 @@ class myCustomWatcher implements QueueChangesWatcher {
         this.client = client;
     }
     shuffled(guildId, oldStoredQueue, newStoredQueue) {
-        console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: Queue got shuffled`)    
+        console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: Queue got shuffled`)
     }
     tracksAdd(guildId, tracks, position, oldStoredQueue, newStoredQueue) {
-        console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: ${tracks.length} Tracks got added into the Queue at position #${position}`);    
+        console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: ${tracks.length} Tracks got added into the Queue at position #${position}`);
     }
     tracksRemoved(guildId, tracks, position, oldStoredQueue, newStoredQueue) {
         console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: ${tracks.length} Tracks got removed from the Queue at position #${position}`);
@@ -185,8 +187,58 @@ client.lavalink = new LavalinkManager({
 })
 ```
 
+## How to do resuming
+
+```js
+// 1. while the player is playing, make sure to enable it:
+const durationToKeepPlayingInMS = 600_000;
+await player.node.updateSession(true, durationToKeepPlayingInMS);
+```
+
+```js
+// 2. make sure to have an eventlistener for resuming events somewhere
+client.lavalink.nodeManager.on("resumed", (node, payload, fetchedPlayers) => {
+  // create players:
+  for(const fetchedPlayer of fetchedPlayers) {
+    const player = client.lavalink.createPlayer({
+       guildId: fetchedPlayer.guildId,
+    });
+    player.setVolume(fetchedPlayer.volume);
+    // and apply other things (e.g. paused, voice, filters, state, ...) (stuff like vc channel, text channel you need to store somewhere)
+    await player.queue.utils.sync(); // only works with a queuestore
+    // you can now overwride the player.queue.current track from the fetchedPlayer, or use the one from the queue.uztils.sync function
+    // continue with your resuming code...
+  }
+})
+```
+
+***
+
+
+### How to use flowertts with custom options
+
+- First enable flowertts within the lava-src plugin
+- Then make sure to pass through the extraQueryUrlParams object
+
+```js
+const query = interaction.options.getString("text");
+const voice = interaction.options.getString("voice");
+
+const extraParams = new URLSearchParams();
+if(voice) extraParams.append(`voice`, voice);
+
+// all params for flowertts can be found here: https://flowery.pw/docs
+const response = await player.search({
+  query: `${query}`,
+  extraQueryUrlParams: extraParams, // as of my knowledge this is currently only used for flowertts, adjusting the playback url dynamically mid-request
+  source: "ftts"
+}, interaction.user);
+```
+
+
 ***
 
+
 # UpdateLog
 
 
@@ -202,8 +254,8 @@ client.lavalink = new LavalinkManager({
   - `player.deleteSponsorBlock()` / `node.deleteSponsorBlock()`
     - That Plugin adds following **Events** to the **Manager**: `"SegmentsLoaded"`, `"SegmentSkipped"`, `"ChapterStarted"`, `"ChaptersLoaded"`
 - Example Bot show example in autoplayFunction how to "disable" / "enable" Autoplay with bot data variables.
-- Added `ManagerOptions#emitNewSongsOnly`. If set to true, it won't emit "trackStart" Event, when track.loop is active, or the new current track == the previous (current) track. 
-- Added `ManagerOptions#linksBlacklist` which allows user to specify an array of regExp / strings to match query strings (for links / words) and if a match happens it doesn't allow the request (blacklist) 
+- Added `ManagerOptions#emitNewSongsOnly`. If set to true, it won't emit "trackStart" Event, when track.loop is active, or the new current track == the previous (current) track.
+- Added `ManagerOptions#linksBlacklist` which allows user to specify an array of regExp / strings to match query strings (for links / words) and if a match happens it doesn't allow the request (blacklist)
 - Added `ManagerOptions#linksWhitelist` which allows user to specify an array of regExp / strings to match query strings (for links only) and if a match does NOT HAPPEN it doesn't allow the request (whitelist)
 - Added `ManagerOptions#linksAllowed` if set to false, it does not allow requests which are links
 - Moved `ManaagerOptions#debugOptions` to `ManaagerOptions#advancedOptions.debugOptions`
@@ -211,10 +263,10 @@ client.lavalink = new LavalinkManager({
 ### **Version 1.2.1**
 - Adjusted `player.stopPlaying()`
   - There are now following parameters. `stopPlaying(clearQueue:boolean = true, executeAutoplay:boolean = false)`.
-    - On Default it now clears the queue and stops playing. Also it does not execute Autoplay on default. IF you want the function to behave differently, you can use the 2 states for that. 
+    - On Default it now clears the queue and stops playing. Also it does not execute Autoplay on default. IF you want the function to behave differently, you can use the 2 states for that.
   - Fixed that it looped the current track if repeatmode === "track" / "queue". (it stops playing and loop stays)
 - Implemented a `parseLavalinkConnUrl(connectionUrl:string)` Util Function.
-  - It allows you to parse Lavalink Connection Data of a Lavalink Connection Url. 
+  - It allows you to parse Lavalink Connection Data of a Lavalink Connection Url.
   Pattern: `lavalink://<nodeId>:<nodeAuthorization(Password)>@<NodeHost>:<NodePort>`
   - Note that the nodeId and NodeAuthorization must be encoded via encodeURIComponents before you provide it into the function.
   - The function will return the following: `{ id: string, authorization: string, host: string, port: number }`
@@ -241,15 +293,15 @@ client.lavalink = new LavalinkManager({
 
 # Node Resuming got supported
 # First enable it by doing:
-+ await player.node.updateResuming(true, 360_000);
++ await player.node.updateSession(true, 360_000);
 # then when reconnecting to the node add to the node.createeOptions the sessionId: "" of the previous session
 # and after  connecting the nodeManager.on("resumed", (node, payload, players) => {}) will be executed, where you can sync the players!
 
 # Node Options got adjusted # It's a property not a method should be treated readonly
-+ node.resuming: { enabled: boolean, timeout: number | null }; 
++ node.resuming: { enabled: boolean, timeout: number | null };
 
 # Player function got added to stop playing without disconnecting
-+ player.stopPlaying(clearQueue:boolean = true, executeAutoplay:boolean = false); 
++ player.stopPlaying(clearQueue:boolean = true, executeAutoplay:boolean = false);
 
 # Node functions for sponsorBlock Plugin (https://github.com/topi314/Sponsorblock-Plugin) got added
 + deleteSponsorBlock(player:Player)
@@ -269,7 +321,7 @@ client.lavalink = new LavalinkManager({
 # Lavalink track.userData got added (basically same feature as my custom pluginInfo.clientData system)
 # You only get the track.userData data through playerUpdate object
 ```
-In one of the next updates, there will be more queueWatcher options and more custom nodeevents to trace 
+In one of the next updates, there will be more queueWatcher options and more custom nodeevents to trace
 
 Most features of this update got tested, but if you encounter any bugs feel free to open an issue!
 
@@ -309,3 +361,52 @@ Most features of this update got tested, but if you encounter any bugs feel free
 - Exporting events
 - Added new debugOption: logCustomSearches
 - *(Next version update i will remove the internal interval for position update, to calculations)*
+
+## **Version 2.2.1**
+- Player position is now calculated instead of using intervals
+- Instaplayer fix update now requires quite good internet connection on the lavalink server due to removal of intervals for updating player.position (everything above 300mbps should be good)
+- Internal updates for handling query params and url-requests (url-parsing) to fix quite few bugs and make the code more readable, now you don't have to ever provide stuff encoded via encodeURIComponent anymore.
+- Added a bunch of jsdoc information, to make the autogenerated docs more accurate!
+
+- Because of the adjustments from the encoding, you now need to pass url params for stuff like flowery tts like this:
+
+```js
+const query = interaction.options.getString("text");
+const voice = interaction.options.getString("voice");
+
+const extraParams = new URLSearchParams();
+if(voice) extraParams.append(`voice`, voice);
+
+// all params for flowertts can be found here: https://flowery.pw/docs
+const response = await player.search({
+  query: `${query}`,
+  extraQueryUrlParams: extraParams, // as of my knowledge this is currently only used for flowertts, adjusting the playback url dynamically mid-request
+  source: "ftts"
+}, interaction.user);
+```
+
+
+## **Version 2.2.2**
+- Fixed a bug in player.pause() where when you pause the track longer than the left over currentTrack.info.duration is, then it would auto skip the track on resume.
+- Fixed the handling of the previous track array ( sometimes it adds "null", due to lavalink errors )
+- Added new functions for the queue, to make migrations and coding easier for beginners,
+  - ` const previousTrack = await player.queue.shiftPrevious() ` -> removes the previously played track from the player.queue.previous array, and returns it, so you can use it for something like "play previous"
+    - *Neat 1-liner: ` await player.queue.shiftPrevious().then(clientTrack => player.play({ clientTrack })) `*
+  - ` await player.queue.remove(removeQuery) ` -> Remove function to remove stuff from the queue.tracks array., following params are valid:
+    - Array of Tracks / UnresolvedTracks, e.g. ` await player.queue.remove( player.queue.tracks.slice(4, 10) ) ` *(would remove tracks from #4 (incl.) to #10 (excl.) aka those indexes: 4, 5, 6, 7, 8, 9 - this is how array.slice works)*
+    - Single Track / UnresolveTrack, e.g. ` await player.queue.remove(player.queue.tracks[player.queue.tracks.length - 1]); ` *(would remove the last track)*
+    - Array of track-indexes, e.g. ` await player.queue.remove([1, 4, 5]) ` *(Would remove track #1, #4 and #5)*
+    - Single track index, e.g. ` await player.queue.remove(5) ` *(would remove the #5 track from the queue)*
+    - **NOTE:** I still highly recommend, to use the ` player.queue.splice() ` function for mutating the queue:
+       - it is possible to remove single tracks, multiple tracks and insert tracks at specific positions!
+    - *the remove function haven't been fully tested yet*
+  - Added `track.pluginInfo.clientData?.previousTrack` handling:
+    - If a track has this property in the pluginInfo in the clientData object set to "true" then it won't get added to the previous track array. Example:
+```js
+const previousTrack = await player.queue.shiftPrevious();
+if(previousTrack) {
+    const previousClientData = previousTrack.pluginInfo.clientData || {};
+    previousTrack.pluginInfo.clientData = { previousTrack: true, ...previousClientData }
+    await player.play({ clientTrack: previousTrack });
+}
+```

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

@@ -7,7 +7,7 @@ export declare class FilterManager {
     /** The Equalizer bands currently applied to the Lavalink Server */
     equalizerBands: EQBand[];
     /** Private Util for the instaFix Filters option */
-    filterUpdatedState: number;
+    filterUpdatedState: boolean;
     /** All "Active" / "disabled" Player Filters */
     filters: PlayerFilters;
     /** The Filter Data sent to Lavalink, only if the filter is enabled (ofc.) */

package/dist/cjs/structures/Filters.js

@@ -8,7 +8,7 @@ class FilterManager {
     /** The Equalizer bands currently applied to the Lavalink Server */
     equalizerBands = [];
     /** Private Util for the instaFix Filters option */
-    filterUpdatedState = 0;
+    filterUpdatedState = false;
     /** All "Active" / "disabled" Player Filters */
     filters = {
         volume: false,
@@ -78,9 +78,9 @@ class FilterManager {
             // "cutoffFrequency": 284, // Integer, higher than zero, in Hz.
             // "boostFactor": 1.24389    // Float, higher than 0.0. This alters volume output. A value of 1.0 means no volume change.
             },
-            "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}. 
+            "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}.
             // "maxAmplitude": 0.6327, // Float, within the range of 0.0 - 1.0. A value of 0.0 mutes the output.
-            // "adaptive": true    // false 
+            // "adaptive": true    // false
             },
             "echo": { // Self-explanatory; provides an echo effect.
             // "echoLength": 0.5649, // Float, higher than 0.0, in seconds (1.0 = 1 second).
@@ -160,6 +160,8 @@ class FilterManager {
                 delete sendData[key];
         }
         const now = performance.now();
+        if (this.player.options.instaUpdateFiltersFix === true)
+            this.filterUpdatedState = true;
         await this.player.node.updatePlayer({
             guildId: this.player.guildId,
             playerOptions: {
@@ -167,8 +169,6 @@ class FilterManager {
             }
         });
         this.player.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;
-        if (this.player.options.instaUpdateFiltersFix === true)
-            this.filterUpdatedState = 1;
         return;
     }
     /**
@@ -253,9 +253,9 @@ class FilterManager {
                 // "cutoffFrequency": 284, // Integer, higher than zero, in Hz.
                 // "boostFactor": 1.24389    // Float, higher than 0.0. This alters volume output. A value of 1.0 means no volume change.
                 },
-                "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}. 
+                "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}.
                 // "maxAmplitude": 0.6327, // Float, within the range of 0.0 - 1.0. A value of 0.0 mutes the output.
-                // "adaptive": true    // false 
+                // "adaptive": true    // false
                 },
                 "echo": { // Self-explanatory; provides an echo effect.
                 // "echoLength": 0.5649, // Float, higher than 0.0, in seconds (1.0 = 1 second).
@@ -654,6 +654,8 @@ class FilterManager {
         if (!this.player.node.sessionId)
             throw new Error("The Lavalink-Node is either not ready or not up to date");
         const now = performance.now();
+        if (this.player.options.instaUpdateFiltersFix === true)
+            this.filterUpdatedState = true;
         await this.player.node.updatePlayer({
             guildId: this.player.guildId,
             playerOptions: {
@@ -661,8 +663,6 @@ class FilterManager {
             }
         });
         this.player.ping.lavalink = Math.round((performance.now() - now) / 10) / 100;
-        if (this.player.options.instaUpdateFiltersFix === true)
-            this.filterUpdatedState = 1;
         return this;
     }
     /** Clears the equalizer bands. */

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

@@ -6,6 +6,7 @@ import { DestroyReasonsType, Player, PlayerJson, PlayerOptions } from "./Player"
 import { ManagerQueueOptions } from "./Queue";
 import { Track, UnresolvedTrack } from "./Track";
 import { ChannelDeletePacket, GuildShardPayload, ManagerUtils, MiniMap, SearchPlatform, SponsorBlockChaptersLoaded, SponsorBlockChapterStarted, SponsorBlockSegmentSkipped, SponsorBlockSegmentsLoaded, TrackEndEvent, TrackExceptionEvent, TrackStartEvent, TrackStuckEvent, VoicePacket, VoiceServer, VoiceState, WebSocketClosedEvent } from "./Utils";
+/** How the botclient is allowed to be structured */
 export interface BotClientOptions {
     /** Bot Client Id */
     id: string;
@@ -14,6 +15,7 @@ export interface BotClientOptions {
     /** So users can pass entire objects / classes */
     [x: string | number | symbol]: unknown;
 }
+/** Sub Manager Options, for player specific things */
 export interface ManagerPlayerOptions {
     /** If the Lavalink Volume should be decremented by x number */
     volumeDecrementer?: number;
@@ -39,6 +41,7 @@ export interface ManagerPlayerOptions {
     };
     useUnresolvedData?: boolean;
 }
+/** Manager Options used to create the manager */
 export interface ManagerOptions {
     /** The Node Options, for all Nodes! (on init) */
     nodes: LavalinkNodeOptions[];
@@ -64,6 +67,8 @@ export interface ManagerOptions {
     linksAllowed?: boolean;
     /** Advanced Options for the Library, which may or may not be "library breaking" */
     advancedOptions?: {
+        /** Max duration for that the filter fix duration works (in ms) - default is 8mins */
+        maxFilterFixDuration?: number;
         /** optional */
         debugOptions?: {
             /** For logging custom searches */
@@ -90,7 +95,7 @@ export interface LavalinkManagerEvents {
      * Emitted when a Track finished.
      * @event Manager#trackEnd
      */
-    "trackEnd": (player: Player, track: Track, payload: TrackEndEvent) => void;
+    "trackEnd": (player: Player, track: Track | null, payload: TrackEndEvent) => void;
     /**
      * Emitted when a Track got stuck while playing.
      * @event Manager#trackStuck
@@ -105,7 +110,7 @@ export interface LavalinkManagerEvents {
      * Emitted when the Playing finished and no more tracks in the queue.
      * @event Manager#queueEnd
      */
-    "queueEnd": (player: Player, track: Track, payload: TrackEndEvent | TrackStuckEvent | TrackExceptionEvent) => void;
+    "queueEnd": (player: Player, track: Track | UnresolvedTrack | null, payload: TrackEndEvent | TrackStuckEvent | TrackExceptionEvent) => void;
     /**
      * Emitted when a Player is created.
      * @event Manager#playerCreate
@@ -142,28 +147,28 @@ export interface LavalinkManagerEvents {
      * @link https://github.com/topi314/Sponsorblock-Plugin#segmentsloaded
      * @event Manager#trackError
      */
-    "SegmentsLoaded": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockSegmentsLoaded) => void;
+    "SegmentsLoaded": (player: Player, track: Track | UnresolvedTrack | null, payload: SponsorBlockSegmentsLoaded) => void;
     /**
      * SPONSORBLOCK-PLUGIN EVENT
      * Emitted when a specific Segment was skipped
      * @link https://github.com/topi314/Sponsorblock-Plugin#segmentskipped
      * @event Manager#trackError
      */
-    "SegmentSkipped": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockSegmentSkipped) => void;
+    "SegmentSkipped": (player: Player, track: Track | UnresolvedTrack | null, payload: SponsorBlockSegmentSkipped) => void;
     /**
      * SPONSORBLOCK-PLUGIN EVENT
      * Emitted when a specific Chapter starts playing
      * @link https://github.com/topi314/Sponsorblock-Plugin#chapterstarted
      * @event Manager#trackError
      */
-    "ChapterStarted": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockChapterStarted) => void;
+    "ChapterStarted": (player: Player, track: Track | UnresolvedTrack | null, payload: SponsorBlockChapterStarted) => void;
     /**
      * SPONSORBLOCK-PLUGIN EVENT
      * Emitted when Chapters are loaded
      * @link https://github.com/topi314/Sponsorblock-Plugin#chaptersloaded
      * @event Manager#trackError
      */
-    "ChaptersLoaded": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockChaptersLoaded) => void;
+    "ChaptersLoaded": (player: Player, track: Track | UnresolvedTrack | null, payload: SponsorBlockChaptersLoaded) => void;
 }
 export interface LavalinkManager {
     /** @private */
@@ -239,6 +244,7 @@ export declare class LavalinkManager extends EventEmitter {
      *     linksBlacklist: [],
      *     linksWhitelist: [],
      *     advancedOptions: {
+     *       maxFilterFixDuration: 600_000,
      *       debugOptions: {
      *         noAudio: false,
      *         playerDestroy: {
@@ -309,10 +315,22 @@ export declare class LavalinkManager extends EventEmitter {
      * Delete's a player from the cache without destroying it on lavalink (only works when it's disconnected)
      * @param guildId
      * @returns
+     *
+     * @example
+     * ```ts
+     * client.lavalink.deletePlayer(interaction.guildId);
+     * // shouldn't be used except you know what you are doing.
+     * ```
      */
     deletePlayer(guildId: string): boolean;
     /**
      * Checks wether the the lib is useable based on if any node is connected
+     *
+     * @example
+     * ```ts
+     * if(!client.lavalink.useable) return console.error("can'T search yet, because there is no useable lavalink node.")
+     * // continue with code e.g. createing a player and searching
+     * ```
      */
     get useable(): boolean;
     /**
@@ -320,7 +338,6 @@ export declare class LavalinkManager extends EventEmitter {
      * @param clientData
      *
      * @example
-     *
      * ```ts
      * // on the bot ready event
      * client.on("ready", () => {

package/dist/cjs/structures/LavalinkManager.js

@@ -58,6 +58,7 @@ class LavalinkManager extends events_1.EventEmitter {
                 queueStore: options?.queueOptions?.queueStore ?? new Queue_1.DefaultQueueStore(),
             },
             advancedOptions: {
+                maxFilterFixDuration: options?.advancedOptions?.maxFilterFixDuration ?? 600000,
                 debugOptions: {
                     logCustomSearches: options?.advancedOptions?.debugOptions?.logCustomSearches ?? false,
                     noAudio: options?.advancedOptions?.debugOptions?.noAudio ?? false,
@@ -150,6 +151,7 @@ class LavalinkManager extends events_1.EventEmitter {
      *     linksBlacklist: [],
      *     linksWhitelist: [],
      *     advancedOptions: {
+     *       maxFilterFixDuration: 600_000,
      *       debugOptions: {
      *         noAudio: false,
      *         playerDestroy: {
@@ -244,12 +246,18 @@ class LavalinkManager extends events_1.EventEmitter {
      * Delete's a player from the cache without destroying it on lavalink (only works when it's disconnected)
      * @param guildId
      * @returns
+     *
+     * @example
+     * ```ts
+     * client.lavalink.deletePlayer(interaction.guildId);
+     * // shouldn't be used except you know what you are doing.
+     * ```
      */
     deletePlayer(guildId) {
         const oldPlayer = this.getPlayer(guildId);
         if (!oldPlayer)
             return;
-        // oldPlayer.connected is operational. you could also do oldPlayer.voice?.token 
+        // oldPlayer.connected is operational. you could also do oldPlayer.voice?.token
         if (oldPlayer.voiceChannelId === "string" && oldPlayer.connected && !oldPlayer.get("internal_destroywithoutdisconnect")) {
             if (!this.options?.advancedOptions?.debugOptions?.playerDestroy?.dontThrowError)
                 throw new Error(`Use Player#destroy() not LavalinkManager#deletePlayer() to stop the Player ${JSON.stringify(oldPlayer.toJSON?.())}`);
@@ -260,6 +268,12 @@ class LavalinkManager extends events_1.EventEmitter {
     }
     /**
      * Checks wether the the lib is useable based on if any node is connected
+     *
+     * @example
+     * ```ts
+     * if(!client.lavalink.useable) return console.error("can'T search yet, because there is no useable lavalink node.")
+     * // continue with code e.g. createing a player and searching
+     * ```
      */
     get useable() {
         return this.nodeManager.nodes.filter(v => v.connected).size > 0;
@@ -269,7 +283,6 @@ class LavalinkManager extends events_1.EventEmitter {
      * @param clientData
      *
      * @example
-     *
      * ```ts
      * // on the bot ready event
      * client.on("ready", () => {

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

@@ -1,5 +1,7 @@
 import { ClientCustomSearchPlatformUtils, LavalinkSearchPlatform, SearchPlatform, SourcesRegex } from "./Utils";
+/** Default Sources Record, to allow source parsing with multiple inputs. */
 export declare const DefaultSources: Record<SearchPlatform, LavalinkSearchPlatform | ClientCustomSearchPlatformUtils>;
+/** Lavalink Plugins definiton */
 export declare const LavalinkPlugins: {
     DuncteBot_Plugin: string;
     LavaSrc: string;
@@ -7,4 +9,5 @@ export declare const LavalinkPlugins: {
     LavaSearch: string;
     LavalinkFilterPlugin: string;
 };
+/** Lavalink Sources regexes for url validations */
 export declare const SourceLinksRegexes: Record<SourcesRegex, RegExp>;

package/dist/cjs/structures/LavalinkManagerStatics.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SourceLinksRegexes = exports.LavalinkPlugins = exports.DefaultSources = void 0;
+/** Default Sources Record, to allow source parsing with multiple inputs. */
 exports.DefaultSources = {
     // youtubemusic
     "youtube music": "ytmsearch",
@@ -25,7 +26,7 @@ exports.DefaultSources = {
     "am": "amsearch",
     "musicapple": "amsearch",
     "music apple": "amsearch",
-    // spotify 
+    // spotify
     "spotify": "spsearch",
     "spsearch": "spsearch",
     "sp": "spsearch",
@@ -66,6 +67,7 @@ exports.DefaultSources = {
     "link": "link",
     "uri": "uri"
 };
+/** Lavalink Plugins definiton */
 exports.LavalinkPlugins = {
     DuncteBot_Plugin: "DuncteBot-plugin",
     LavaSrc: "lavasrc-plugin",
@@ -73,6 +75,7 @@ exports.LavalinkPlugins = {
     LavaSearch: "lavasearch-plugin",
     LavalinkFilterPlugin: "lavalink-filter-plugin"
 };
+/** Lavalink Sources regexes for url validations */
 exports.SourceLinksRegexes = {
     /** DEFAULT SUPPORTED BY LAVALINK */
     YoutubeRegex: /https?:\/\/?(?:www\.)?(?:(m|www)\.)?(?:youtu\.be\/|youtube\.com\/(?:embed\/|v\/|shorts|playlist\?|watch\?v=|watch\?.+(?:&|&);v=))([a-zA-Z0-9\-_]{11})?(?:(?:\?|&|&)index=((?:\d){1,3}))?(?:(?:\?|&|&)?list=([a-zA-Z\-_0-9]{34}))?(?:\S+)?/,