lavalink-client 2.9.11 → 2.10.0

package/README.md

@@ -111,8 +111,16 @@ pnpm add tomato6966/lavalink-client
 
 This client can be used with nodelink too, but because nodelink's websocket is different than the one from lavalink, you need to disable a few things on the NODE OPTIONS / NODE PROPERTIES:
 
+Import the NodeType Enum:
+
+```
+import { NodeType } from "lavalink-client"
+```
+
+// You must assign NodeLink enum to nodeType of the node options, before creating the node.
+
 ```ts
-nodeOptions.nodeType = "NodeLink";
+nodeOptions.nodeType = NodeType.NodeLink;
 ```
 
 this can be done directly when creating the node in the lavalinkmanager.
@@ -122,7 +130,7 @@ client.lavalink = new LavalinkManager({
     nodes: [
         {
             host: "localhost",
-            nodeType: "NodeLink",
+            nodeType: NodeType.NodeLink, // provide nodeType "nodelink" to it.
         },
     ],
 });
@@ -135,8 +143,10 @@ client.lavalink = new LavalinkManager({
             port: 2333,
             id: "Main Node",
             // set to nodeLink
-            nodeType: "NodeLink",
+            nodeType: NodeType.NodeLink, // provide it here
         },
+        // you can also use the util like this, and it will return a valid node option object. must start with: lavalink:// | nodelink://
+        // parseLavalinkConnUrl("nodelink://<nodeId>:<nodeAuthorization(Password)>@<NodeHost>:<NodePort>")
     ],
     // A function to send voice server updates to the Lavalink client
     sendToShard: (guildId, payload) => {
@@ -392,6 +402,8 @@ client.lavalink = new LavalinkManager({
             port: 2333,
             id: "Main Node",
         },
+        // you can also use the util like this, and it will return a valid node option object.
+        // parseLavalinkConnUrl("nodelink://<nodeId>:<nodeAuthorization(Password)>@<NodeHost>:<NodePort>")
     ],
     // A function to send voice server updates to the Lavalink client
     sendToShard: (guildId, payload) => {
@@ -448,6 +460,8 @@ client.lavalink = new LavalinkManager({
             retryAmount: 5,
             retryDelay: 10_000, // 10 seconds
         },
+        // you can also use the util like this, and it will return a valid node option object. must start with: lavalink:// | nodelink://
+        // parseLavalinkConnUrl("lavalink://<nodeId>:<nodeAuthorization(Password)>@<NodeHost>:<NodePort>")
     ],
     sendToShard: (guildId, payload) => client.guilds.cache.get(guildId)?.shard?.send(payload),
     autoSkip: true, // automatically play the next song of the queue, on: trackend, trackerror, trackexception

package/dist/index.cjs

@@ -45,6 +45,7 @@ __export(index_exports, {
   NodeLinkNode: () => NodeLinkNode,
   NodeManager: () => NodeManager,
   NodeSymbol: () => NodeSymbol,
+  NodeType: () => NodeType,
   Player: () => Player,
   Queue: () => Queue,
   QueueSaver: () => QueueSaver,
@@ -403,9 +404,6 @@ var NodeLinkExclusiveEvents = [
   "LyricsNotFoundEvent"
 ];
 
-// src/structures/NodeManager.ts
-var import_node_events = require("events");
-
 // src/structures/Node.ts
 var import_node_path = require("path");
 var import_ws = __toESM(require("ws"), 1);
@@ -418,6 +416,11 @@ var ReconnectionState = /* @__PURE__ */ ((ReconnectionState2) => {
   ReconnectionState2["DESTROYING"] = "DESTROYING";
   return ReconnectionState2;
 })(ReconnectionState || {});
+var NodeType = /* @__PURE__ */ ((NodeType2) => {
+  NodeType2["Lavalink"] = "Lavalink";
+  NodeType2["NodeLink"] = "NodeLink";
+  return NodeType2;
+})(NodeType || {});
 
 // src/structures/Utils.ts
 var import_node_url = require("url");
@@ -589,12 +592,14 @@ var QueueSymbol = /* @__PURE__ */ Symbol("LC-Queue");
 var NodeSymbol = /* @__PURE__ */ Symbol("LC-Node");
 var escapeRegExp = (str) => str.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
 function parseLavalinkConnUrl(connectionUrl) {
-  if (!connectionUrl.startsWith("lavalink://") && !connectionUrl.startsWith("nodelink://"))
+  if (!connectionUrl) throw new Error("ConnectionUrl is required");
+  const lowered = connectionUrl.toLowerCase();
+  if (!lowered.startsWith("lavalink://") && !lowered.startsWith("nodelink://"))
     throw new Error(`ConnectionUrl (${connectionUrl}) must start with 'lavalink://' or 'nodelink://'`);
   const parsed = new import_node_url.URL(connectionUrl);
   return {
     authorization: parsed.password,
-    nodeType: connectionUrl.startsWith("lavalink://") ? "Lavalink" : "NodeLink",
+    nodeType: lowered.startsWith("lavalink://") ? "Lavalink" /* Lavalink */ : "NodeLink" /* NodeLink */,
     id: parsed.username,
     host: parsed.hostname,
     port: Number(parsed.port)
@@ -1248,7 +1253,7 @@ var LavalinkNode = class _LavalinkNode {
   heartBeatPongTimestamp = 0;
   heartBeatInterval;
   pingTimeout;
-  nodeType = "Lavalink";
+  nodeType = "Lavalink" /* Lavalink */;
   isAlive = false;
   static _NodeLinkClass = null;
   /** The provided Options of the Node */
@@ -1322,7 +1327,7 @@ var LavalinkNode = class _LavalinkNode {
    * Returns wether the plugin validations are enabled or not
    */
   get _checkForPlugins() {
-    if (this.nodeType === "NodeLink") return false;
+    if (this.nodeType === "NodeLink" /* NodeLink */) return false;
     return !!this.options?.autoChecks?.pluginValidations;
   }
   /**
@@ -1392,16 +1397,17 @@ var LavalinkNode = class _LavalinkNode {
       heartBeatInterval: 3e4,
       enablePingOnStatsCheck: true,
       closeOnError: true,
+      nodeType: "Lavalink" /* Lavalink */,
       ...options,
       autoChecks: {
         sourcesValidations: options?.autoChecks?.sourcesValidations ?? true,
         pluginValidations: options?.autoChecks?.pluginValidations ?? true
       }
     };
-    if (this.options.nodeType === "NodeLink" && this.constructor.name === "LavalinkNode" && _LavalinkNode._NodeLinkClass) {
+    if (this.options.nodeType === "NodeLink" /* NodeLink */ && this.constructor.name === "LavalinkNode" && _LavalinkNode._NodeLinkClass) {
       return new _LavalinkNode._NodeLinkClass(options, manager);
     }
-    this.nodeType = this.options.nodeType || "Lavalink";
+    this.nodeType = this.options.nodeType;
     this.NodeManager = manager;
     this.validate();
     if (this.options.secure && this.options.port !== 443)
@@ -2344,20 +2350,22 @@ var LavalinkNode = class _LavalinkNode {
       throw new SyntaxError("LavalinkNode.autoChecks.pluginValidations must be either false | true aka boolean");
     if (this.options.regions !== void 0 && (!Array.isArray(this.options.regions) || !this.options.regions.every((r) => typeof r === "string")))
       throw new SyntaxError("LavalinkNode.regions must be an Array of strings");
+    if (this.options.nodeType && !NodeType[this.options.nodeType])
+      throw new SyntaxError("LavalinkNode.nodeType must be a valid NodeType enum value");
   }
   /**
    * Checks if the node is a NodeLink node
    * @returns true if the node is a NodeLink node
    */
   isNodeLink() {
-    return this.nodeType === "NodeLink";
+    return this.nodeType === "NodeLink" /* NodeLink */;
   }
   /**
    * Checks if the node is a Lavalink node
    * @returns true if the node is a Lavalink node
    */
   isLavalinkNode() {
-    return this.nodeType === "Lavalink";
+    return this.nodeType === "Lavalink" /* Lavalink */;
   }
   /**
    * Sync the data of the player you make an action to lavalink to
@@ -3130,13 +3138,13 @@ var LavalinkNode = class _LavalinkNode {
 
 // src/structures/NodeLink.ts
 var NodeLinkNode = class extends LavalinkNode {
-  nodeType = "NodeLink";
+  nodeType = "NodeLink" /* NodeLink */;
   constructor(options, manager) {
     super(options, manager);
-    if (this.options.nodeType === "Lavalink" && this.constructor.name === "NodeLink") {
+    if (this.options.nodeType === "Lavalink" /* Lavalink */ && (this.constructor.name === "NodeLinkNode" || this.constructor.name === "NodeLink")) {
       return new LavalinkNode(options, manager);
     }
-    this.nodeType = "NodeLink";
+    this.nodeType = "NodeLink" /* NodeLink */;
   }
   /**
    * Uses the gapless feature to set the next track to be played.
@@ -3477,6 +3485,7 @@ var NodeLinkNode = class extends LavalinkNode {
 LavalinkNode._NodeLinkClass = NodeLinkNode;
 
 // src/structures/NodeManager.ts
+var import_node_events = require("events");
 var NodeManager = class extends import_node_events.EventEmitter {
   /**
    * Emit an event
@@ -3538,9 +3547,7 @@ var NodeManager = class extends import_node_events.EventEmitter {
     super();
     this.LavalinkManager = LavalinkManager2;
     if (this.LavalinkManager.options.nodes)
-      this.LavalinkManager.options.nodes.forEach((node) => {
-        this.createNode(node);
-      });
+      this.LavalinkManager.options.nodes.forEach((node) => this.createNode(node));
   }
   /**
    * Disconnects all Nodes from lavalink ws sockets
@@ -3601,9 +3608,21 @@ var NodeManager = class extends import_node_events.EventEmitter {
    * @returns The node that was created
    */
   createNode(options) {
+    if (options instanceof NodeLinkNode) {
+      const preExistingNode = this.nodes.get(options.id);
+      if (preExistingNode) return preExistingNode;
+      this.nodes.set(options.id, options);
+      return options;
+    }
+    if (options instanceof LavalinkNode) {
+      const preExistingNode = this.nodes.get(options.id);
+      if (preExistingNode) return preExistingNode;
+      this.nodes.set(options.id, options);
+      return options;
+    }
     if (this.nodes.has(options.id || `${options.host}:${options.port}`))
       return this.nodes.get(options.id || `${options.host}:${options.port}`);
-    const newNode = options.nodeType === "NodeLink" ? new NodeLinkNode(options, this) : new LavalinkNode(options, this);
+    const newNode = options.nodeType === "NodeLink" /* NodeLink */ ? new NodeLinkNode(options, this) : new LavalinkNode(options, this);
     this.nodes.set(newNode.id, newNode);
     return newNode;
   }
@@ -3612,48 +3631,57 @@ var NodeManager = class extends import_node_events.EventEmitter {
    * @param sortType The type of sorting to use
    * @returns
    */
-  leastUsedNodes(sortType = "players") {
+  leastUsedNodes(sortType = "players", filterForNodeTypes) {
+    const normalizedFilterForNodeTypes = filterForNodeTypes?.length ? filterForNodeTypes : ["Lavalink" /* Lavalink */, "NodeLink" /* NodeLink */];
     const connectedNodes = Array.from(this.nodes.values()).filter((node) => node.connected);
+    const normalizedNodeTypes = new Set(
+      normalizedFilterForNodeTypes.map(
+        (nodeTypeFilter) => Object.values(NodeType).includes(nodeTypeFilter) ? nodeTypeFilter : nodeTypeFilter.nodeType
+      )
+    );
+    const filteredConnectedNodes = connectedNodes.filter((node) => normalizedNodeTypes.has(node.nodeType));
     switch (sortType) {
       case "memory":
         {
-          return connectedNodes.sort((a, b) => (a.stats?.memory?.used || 0) - (b.stats?.memory?.used || 0));
+          return filteredConnectedNodes.sort(
+            (a, b) => (a.stats?.memory?.used || 0) - (b.stats?.memory?.used || 0)
+          );
         }
         break;
       case "cpuLavalink":
         {
-          return connectedNodes.sort(
+          return filteredConnectedNodes.sort(
             (a, b) => (a.stats?.cpu?.lavalinkLoad || 0) - (b.stats?.cpu?.lavalinkLoad || 0)
           );
         }
         break;
       case "cpuSystem":
         {
-          return connectedNodes.sort(
+          return filteredConnectedNodes.sort(
             (a, b) => (a.stats?.cpu?.systemLoad || 0) - (b.stats?.cpu?.systemLoad || 0)
           );
         }
         break;
       case "calls":
         {
-          return connectedNodes.sort((a, b) => a.calls - b.calls);
+          return filteredConnectedNodes.sort((a, b) => a.calls - b.calls);
         }
         break;
       case "playingPlayers":
         {
-          return connectedNodes.sort(
+          return filteredConnectedNodes.sort(
             (a, b) => (a.stats?.playingPlayers || 0) - (b.stats?.playingPlayers || 0)
           );
         }
         break;
       case "players":
         {
-          return connectedNodes.sort((a, b) => (a.stats?.players || 0) - (b.stats?.players || 0));
+          return filteredConnectedNodes.sort((a, b) => (a.stats?.players || 0) - (b.stats?.players || 0));
         }
         break;
       default:
         {
-          return connectedNodes.sort((a, b) => (a.stats?.players || 0) - (b.stats?.players || 0));
+          return filteredConnectedNodes.sort((a, b) => (a.stats?.players || 0) - (b.stats?.players || 0));
         }
         break;
     }
@@ -3686,13 +3714,22 @@ var NodeManager = class extends import_node_events.EventEmitter {
   }
   /**
    * Get a node from the nodeManager
-   * @param node The node to get
+   * @param node The node to get either by idetnifier, by class or by enum
    * @returns The node that was retrieved
    */
   getNode(node) {
+    if (!!node && Object.values(NodeType).includes(node)) {
+      return this.leastUsedNodes().filter((node2) => node2.nodeType === node2)[0];
+    }
+    if (!!node && node instanceof NodeLinkNode) {
+      return this.leastUsedNodes().filter((node2) => node2 instanceof NodeLinkNode)[0];
+    }
+    if (!!node && node instanceof LavalinkNode) {
+      return this.leastUsedNodes().filter((node2) => node2 instanceof LavalinkNode)[0];
+    }
     const decodeNode = typeof node === "string" ? this.nodes.get(node) : node;
     if (!decodeNode) return void 0;
-    if (decodeNode.nodeType === "NodeLink") return decodeNode;
+    if (decodeNode.nodeType === "NodeLink" /* NodeLink */) return decodeNode;
     return decodeNode;
   }
 };
@@ -6331,9 +6368,11 @@ var LavalinkManager = class _LavalinkManager extends import_node_events2.EventEm
       throw new SyntaxError("ManagerOption.autoSkipOnResolveError must be either false | true aka boolean");
     if (options?.emitNewSongsOnly && typeof options?.emitNewSongsOnly !== "boolean")
       throw new SyntaxError("ManagerOption.emitNewSongsOnly must be either false | true aka boolean");
-    if (!options?.nodes || !Array.isArray(options?.nodes) || !options?.nodes.every((node) => this.utils.isNodeOptions(node)))
+    if (!options?.nodes || !Array.isArray(options?.nodes) || !options?.nodes.every(
+      (node) => node instanceof NodeLinkNode || node instanceof LavalinkNode || this.utils.isNodeOptions(node)
+    ))
       throw new SyntaxError(
-        "ManagerOption.nodes must be an Array of NodeOptions and is required of at least 1 Node"
+        "ManagerOption.nodes must be an Array of NodeOptions or the Node-Classes 'NodeLinkNode' or 'LavalinkNode' and is required of at least 1 Node"
       );
     if (options?.queueOptions?.queueStore) {
       const keys = Object.getOwnPropertyNames(Object.getPrototypeOf(options?.queueOptions?.queueStore));
@@ -6389,48 +6428,50 @@ var LavalinkManager = class _LavalinkManager extends import_node_events2.EventEm
    *       port: 2333,
    *       id: "testnode"
    *     },
+   *     // you can also use the util like this, and it will return a valid node option object. must start with: lavalink:// | nodelink://
+   *     // parseLavalinkConnUrl("nodelink://<nodeId>:<nodeAuthorization(Password)>@<NodeHost>:<NodePort>")
    *     sendToShard(guildId, payload) => client.guilds.cache.get(guildId)?.shard?.send(payload),
-   *     client: {
-   *       id: process.env.CLIENT_ID,
-   *       username: "TESTBOT"
-   *     },
-   *     // optional Options:
-   *     autoSkip: true,
-   *     playerOptions: {
-   *       applyVolumeAsFilter: false,
-   *       clientBasedPositionUpdateInterval: 150,
-   *       defaultSearchPlatform: "ytmsearch",
-   *       allowCustomSources: false,
-   *       volumeDecrementer: 0.75,
-   *       //requesterTransformer: YourRequesterTransformerFunction,
-   *       onDisconnect: {
-   *         autoReconnect: true,
-   *         destroyPlayer: false
-   *       },
-   *       onEmptyQueue: {
-   *         destroyAfterMs: 30_000,
-   *         //autoPlayFunction: YourAutoplayFunction,
-   *       },
-   *       useUnresolvedData: true
+   *   ],
+   *   client: {
+   *     id: process.env.CLIENT_ID,
+   *     username: "TESTBOT"
+   *   },
+   *   // optional Options:
+   *   autoSkip: true,
+   *   playerOptions: {
+   *     applyVolumeAsFilter: false,
+   *     clientBasedPositionUpdateInterval: 150,
+   *     defaultSearchPlatform: "ytmsearch",
+   *     allowCustomSources: false,
+   *     volumeDecrementer: 0.75,
+   *     //requesterTransformer: YourRequesterTransformerFunction,
+   *     onDisconnect: {
+   *       autoReconnect: true,
+   *       destroyPlayer: false
    *     },
-   *     queueOptions: {
-   *       maxPreviousTracks: 25,
-   *       //queueStore: yourCustomQueueStoreManagerClass,
-   *       //queueChangesWatcher: yourCustomQueueChangesWatcherClass
+   *     onEmptyQueue: {
+   *       destroyAfterMs: 30_000,
+   *       //autoPlayFunction: YourAutoplayFunction,
    *     },
-   *     linksBlacklist: [],
-   *     linksWhitelist: [],
-   *     advancedOptions: {
-   *       maxFilterFixDuration: 600_000,
-   *       debugOptions: {
-   *         noAudio: false,
-   *         playerDestroy: {
-   *           dontThrowError: false,
-   *           debugLogs: false
-   *         }
+   *     useUnresolvedData: true
+   *   },
+   *   queueOptions: {
+   *     maxPreviousTracks: 25,
+   *     //queueStore: yourCustomQueueStoreManagerClass,
+   *     //queueChangesWatcher: yourCustomQueueChangesWatcherClass
+   *   },
+   *   linksBlacklist: [],
+   *   linksWhitelist: [],
+   *   advancedOptions: {
+   *     maxFilterFixDuration: 600_000,
+   *     debugOptions: {
+   *       noAudio: false,
+   *       playerDestroy: {
+   *         dontThrowError: false,
+   *         debugLogs: false
    *       }
    *     }
-   *   ]
+   *   }
    * })
    * ```
    */
@@ -6839,6 +6880,7 @@ var LavalinkManager = class _LavalinkManager extends import_node_events2.EventEm
   NodeLinkNode,
   NodeManager,
   NodeSymbol,
+  NodeType,
   Player,
   Queue,
   QueueSaver,

package/dist/index.d.cts

@@ -410,7 +410,7 @@ declare const NodeSymbol: unique symbol;
  */
 declare function parseLavalinkConnUrl(connectionUrl: string): {
     authorization: string;
-    nodeType: NodeTypes;
+    nodeType: NodeType;
     id: string;
     host: string;
     port: number;
@@ -1537,7 +1537,7 @@ type SponsorBlockSegment = "sponsor" | "selfpromo" | "interaction" | "intro" | "
  */
 interface LavalinkNodeOptions {
     /** Specify the Node-Type of this node. Default: Lavalink */
-    nodeType?: NodeTypes;
+    nodeType?: NodeType;
     /** The Lavalink Server-Ip / Domain-URL */
     host: string;
     /** The Lavalink Connection Port */
@@ -1832,7 +1832,10 @@ declare enum ReconnectionState {
     PENDING = "PENDING",
     DESTROYING = "DESTROYING"
 }
-type NodeTypes = "Lavalink" | "NodeLink";
+declare enum NodeType {
+    Lavalink = "Lavalink",
+    NodeLink = "NodeLink"
+}
 
 declare class FilterManager {
     static EQList: {
@@ -2891,7 +2894,7 @@ declare class Player {
 }
 
 declare class NodeLinkNode extends LavalinkNode {
-    nodeType: "NodeLink";
+    nodeType: NodeType;
     constructor(options: LavalinkNodeOptions, manager: NodeManager);
     /**
      * Uses the gapless feature to set the next track to be played.
@@ -3064,7 +3067,7 @@ declare class LavalinkNode {
     private heartBeatPongTimestamp;
     private heartBeatInterval?;
     private pingTimeout?;
-    nodeType: NodeTypes;
+    nodeType: NodeType;
     isAlive: boolean;
     static _NodeLinkClass: unknown;
     /** The provided Options of the Node */
@@ -3749,13 +3752,13 @@ declare class NodeManager extends EventEmitter {
      * @param options The options for the node
      * @returns The node that was created
      */
-    createNode<T extends LavalinkNode | NodeLinkNode>(options: LavalinkNodeOptions): T;
+    createNode<T extends LavalinkNode | NodeLinkNode>(options: LavalinkNodeOptions | NodeLinkNode | LavalinkNode): T;
     /**
      * Get the nodes sorted for the least usage, by a sorttype
      * @param sortType The type of sorting to use
      * @returns
      */
-    leastUsedNodes(sortType?: "memory" | "cpuLavalink" | "cpuSystem" | "calls" | "playingPlayers" | "players"): LavalinkNode[];
+    leastUsedNodes(sortType?: "memory" | "cpuLavalink" | "cpuSystem" | "calls" | "playingPlayers" | "players", filterForNodeTypes?: (NodeType | NodeLinkNode | LavalinkNode)[]): LavalinkNode[];
     /**
      * Delete a node from the nodeManager and destroy it
      * @param node The node to delete
@@ -3775,10 +3778,10 @@ declare class NodeManager extends EventEmitter {
     deleteNode(node: LavalinkNodeIdentifier | LavalinkNode | NodeLinkNode, movePlayers?: boolean): void;
     /**
      * Get a node from the nodeManager
-     * @param node The node to get
+     * @param node The node to get either by idetnifier, by class or by enum
      * @returns The node that was retrieved
      */
-    getNode(node: LavalinkNodeIdentifier | LavalinkNode | NodeLinkNode): LavalinkNode | NodeLinkNode | undefined;
+    getNode(node: LavalinkNodeIdentifier | LavalinkNode | NodeLinkNode | NodeType): LavalinkNode | NodeLinkNode | undefined;
 }
 
 /**
@@ -4038,7 +4041,7 @@ type PlayerConstructor<T extends Player = Player> = new (options: PlayerOptions,
 /** Manager Options used to create the manager */
 interface ManagerOptions<CustomPlayerT extends Player = Player> {
     /** The Node Options, for all Nodes! (on init) */
-    nodes: LavalinkNodeOptions[];
+    nodes: (LavalinkNodeOptions | NodeLinkNode | LavalinkNode)[];
     /** @async The Function to send the voice connection changes from Lavalink to Discord */
     sendToShard: (guildId: string, payload: GuildShardPayload) => void;
     /** The Bot Client's Data for Authorization */
@@ -4169,48 +4172,50 @@ declare class LavalinkManager<CustomPlayerT extends Player = Player> extends Eve
      *       port: 2333,
      *       id: "testnode"
      *     },
+     *     // you can also use the util like this, and it will return a valid node option object. must start with: lavalink:// | nodelink://
+     *     // parseLavalinkConnUrl("nodelink://<nodeId>:<nodeAuthorization(Password)>@<NodeHost>:<NodePort>")
      *     sendToShard(guildId, payload) => client.guilds.cache.get(guildId)?.shard?.send(payload),
-     *     client: {
-     *       id: process.env.CLIENT_ID,
-     *       username: "TESTBOT"
-     *     },
-     *     // optional Options:
-     *     autoSkip: true,
-     *     playerOptions: {
-     *       applyVolumeAsFilter: false,
-     *       clientBasedPositionUpdateInterval: 150,
-     *       defaultSearchPlatform: "ytmsearch",
-     *       allowCustomSources: false,
-     *       volumeDecrementer: 0.75,
-     *       //requesterTransformer: YourRequesterTransformerFunction,
-     *       onDisconnect: {
-     *         autoReconnect: true,
-     *         destroyPlayer: false
-     *       },
-     *       onEmptyQueue: {
-     *         destroyAfterMs: 30_000,
-     *         //autoPlayFunction: YourAutoplayFunction,
-     *       },
-     *       useUnresolvedData: true
+     *   ],
+     *   client: {
+     *     id: process.env.CLIENT_ID,
+     *     username: "TESTBOT"
+     *   },
+     *   // optional Options:
+     *   autoSkip: true,
+     *   playerOptions: {
+     *     applyVolumeAsFilter: false,
+     *     clientBasedPositionUpdateInterval: 150,
+     *     defaultSearchPlatform: "ytmsearch",
+     *     allowCustomSources: false,
+     *     volumeDecrementer: 0.75,
+     *     //requesterTransformer: YourRequesterTransformerFunction,
+     *     onDisconnect: {
+     *       autoReconnect: true,
+     *       destroyPlayer: false
      *     },
-     *     queueOptions: {
-     *       maxPreviousTracks: 25,
-     *       //queueStore: yourCustomQueueStoreManagerClass,
-     *       //queueChangesWatcher: yourCustomQueueChangesWatcherClass
+     *     onEmptyQueue: {
+     *       destroyAfterMs: 30_000,
+     *       //autoPlayFunction: YourAutoplayFunction,
      *     },
-     *     linksBlacklist: [],
-     *     linksWhitelist: [],
-     *     advancedOptions: {
-     *       maxFilterFixDuration: 600_000,
-     *       debugOptions: {
-     *         noAudio: false,
-     *         playerDestroy: {
-     *           dontThrowError: false,
-     *           debugLogs: false
-     *         }
+     *     useUnresolvedData: true
+     *   },
+     *   queueOptions: {
+     *     maxPreviousTracks: 25,
+     *     //queueStore: yourCustomQueueStoreManagerClass,
+     *     //queueChangesWatcher: yourCustomQueueChangesWatcherClass
+     *   },
+     *   linksBlacklist: [],
+     *   linksWhitelist: [],
+     *   advancedOptions: {
+     *     maxFilterFixDuration: 600_000,
+     *     debugOptions: {
+     *       noAudio: false,
+     *       playerDestroy: {
+     *         dontThrowError: false,
+     *         debugLogs: false
      *       }
      *     }
-     *   ]
+     *   }
      * })
      * ```
      */
@@ -4339,4 +4344,4 @@ declare const LavalinkPlugins: {
 /** Lavalink Sources regexes for url validations */
 declare const SourceLinksRegexes: Record<SourcesRegex, RegExp>;
 
-export { type AudioOutputs, type Awaitable, type Base64, type BaseNodeStats, type BasePlayOptions, type BotClientOptions, type CPUStats, type ChannelDeletePacket, type ChannelMixFilter, type ClientCustomSearchPlatformUtils, type ClientSearchPlatform, DebugEvents, type DeepRequired, DefaultQueueStore, DefaultSources, DestroyReasons, type DestroyReasonsType, DisconnectReasons, type DisconnectReasonsType, type DistortionFilter, type DuncteSearchPlatform, type EQBand, EQList, type Exception, type FailingAddress, type FilterData, FilterManager, type FloatNumber, type FrameStats, type GitObject, type GuildShardPayload, type IntegerNumber, type InvalidLavalinkRestRequest, type JioSaavnSearchPlatform, type KaraokeFilter, type LavaSearchFilteredResponse, type LavaSearchQuery, type LavaSearchResponse, type LavaSearchType, type LavaSrcSearchPlatform, type LavaSrcSearchPlatformBase, type LavalinkClientSearchPlatform, type LavalinkClientSearchPlatformResolve, type LavalinkFilterData, type LavalinkInfo, LavalinkManager, type LavalinkManagerEvents, LavalinkNode, type LavalinkNodeIdentifier, type LavalinkNodeOptions, type LavalinkPlayOptions, type LavalinkPlayer, type LavalinkPlayerVoice, type LavalinkPlayerVoiceOptions, type LavalinkPlugin_JioSaavn_SourceNames, type LavalinkPlugin_LavaSrc_SourceNames, LavalinkPlugins, type LavalinkSearchPlatform, type LavalinkSourceNames, type LavalinkTrack, type LavalinkTrackInfo, type LoadTypes, type LowPassFilter, type LyricsEvent, type LyricsEventType, type LyricsFoundEvent, type LyricsLine, type LyricsLineEvent, type LyricsNotFoundEvent, type LyricsResult, type ManagerOptions, type ManagerPlayerOptions, type ManagerQueueOptions, ManagerUtils, type MemoryStats, MiniMap, type MiniMapConstructor, type ModifyRequest, type NodeLinkConnectionMetrics, NodeLinkExclusiveEvents, NodeLinkNode, type NodeLink_ChorusFilter, type NodeLink_CompressorFilter, type NodeLink_EchoFilter, type NodeLink_HighPassFilter, type NodeLink_PhaserFilter, type NodeLink_SpatialFilter, NodeManager, type NodeManagerEvents, type NodeMessage, type NodeStats, NodeSymbol, type NodeTypes, type Opaque, type PlayOptions, Player, type PlayerEvent, type PlayerEventType, type PlayerEvents, type PlayerFilters, type PlayerJson, type PlayerOptions, type PlayerUpdateInfo, type PlaylistInfo, type PluginInfo, type PluginObject, Queue, type QueueChangesWatcher, QueueSaver, type QueueStoreManager, QueueSymbol, RecommendationsStrings, ReconnectionState, type RepeatMode, type RequiredManagerOptions, type RotationFilter, type RoutePlanner, type RoutePlannerTypes, type SearchPlatform, type SearchQuery, type SearchResult, type Session, type Severity, SourceLinksRegexes, type SourceNames, type SourcesRegex, type SponsorBlockChapterStarted, type SponsorBlockChaptersLoaded, type SponsorBlockSegment, type SponsorBlockSegmentEventType, type SponsorBlockSegmentEvents, type SponsorBlockSegmentSkipped, type SponsorBlockSegmentsLoaded, type State, type StoredQueue, type TimescaleFilter, type Track, type TrackEndEvent, type TrackEndReason, type TrackExceptionEvent, type TrackInfo, type TrackRequester, type TrackStartEvent, type TrackStuckEvent, TrackSymbol, type TremoloFilter, type UnresolvedQuery, type UnresolvedSearchResult, type UnresolvedTrack, type UnresolvedTrackInfo, UnresolvedTrackSymbol, type VersionObject, type VibratoFilter, type VoicePacket, type VoiceServer, type VoiceState, type WebSocketClosedEvent, type anyObject, audioOutputsData, parseLavalinkConnUrl, queueTrackEnd, safeStringify, validSponsorBlocks };
+export { type AudioOutputs, type Awaitable, type Base64, type BaseNodeStats, type BasePlayOptions, type BotClientOptions, type CPUStats, type ChannelDeletePacket, type ChannelMixFilter, type ClientCustomSearchPlatformUtils, type ClientSearchPlatform, DebugEvents, type DeepRequired, DefaultQueueStore, DefaultSources, DestroyReasons, type DestroyReasonsType, DisconnectReasons, type DisconnectReasonsType, type DistortionFilter, type DuncteSearchPlatform, type EQBand, EQList, type Exception, type FailingAddress, type FilterData, FilterManager, type FloatNumber, type FrameStats, type GitObject, type GuildShardPayload, type IntegerNumber, type InvalidLavalinkRestRequest, type JioSaavnSearchPlatform, type KaraokeFilter, type LavaSearchFilteredResponse, type LavaSearchQuery, type LavaSearchResponse, type LavaSearchType, type LavaSrcSearchPlatform, type LavaSrcSearchPlatformBase, type LavalinkClientSearchPlatform, type LavalinkClientSearchPlatformResolve, type LavalinkFilterData, type LavalinkInfo, LavalinkManager, type LavalinkManagerEvents, LavalinkNode, type LavalinkNodeIdentifier, type LavalinkNodeOptions, type LavalinkPlayOptions, type LavalinkPlayer, type LavalinkPlayerVoice, type LavalinkPlayerVoiceOptions, type LavalinkPlugin_JioSaavn_SourceNames, type LavalinkPlugin_LavaSrc_SourceNames, LavalinkPlugins, type LavalinkSearchPlatform, type LavalinkSourceNames, type LavalinkTrack, type LavalinkTrackInfo, type LoadTypes, type LowPassFilter, type LyricsEvent, type LyricsEventType, type LyricsFoundEvent, type LyricsLine, type LyricsLineEvent, type LyricsNotFoundEvent, type LyricsResult, type ManagerOptions, type ManagerPlayerOptions, type ManagerQueueOptions, ManagerUtils, type MemoryStats, MiniMap, type MiniMapConstructor, type ModifyRequest, type NodeLinkConnectionMetrics, NodeLinkExclusiveEvents, NodeLinkNode, type NodeLink_ChorusFilter, type NodeLink_CompressorFilter, type NodeLink_EchoFilter, type NodeLink_HighPassFilter, type NodeLink_PhaserFilter, type NodeLink_SpatialFilter, NodeManager, type NodeManagerEvents, type NodeMessage, type NodeStats, NodeSymbol, NodeType, type Opaque, type PlayOptions, Player, type PlayerEvent, type PlayerEventType, type PlayerEvents, type PlayerFilters, type PlayerJson, type PlayerOptions, type PlayerUpdateInfo, type PlaylistInfo, type PluginInfo, type PluginObject, Queue, type QueueChangesWatcher, QueueSaver, type QueueStoreManager, QueueSymbol, RecommendationsStrings, ReconnectionState, type RepeatMode, type RequiredManagerOptions, type RotationFilter, type RoutePlanner, type RoutePlannerTypes, type SearchPlatform, type SearchQuery, type SearchResult, type Session, type Severity, SourceLinksRegexes, type SourceNames, type SourcesRegex, type SponsorBlockChapterStarted, type SponsorBlockChaptersLoaded, type SponsorBlockSegment, type SponsorBlockSegmentEventType, type SponsorBlockSegmentEvents, type SponsorBlockSegmentSkipped, type SponsorBlockSegmentsLoaded, type State, type StoredQueue, type TimescaleFilter, type Track, type TrackEndEvent, type TrackEndReason, type TrackExceptionEvent, type TrackInfo, type TrackRequester, type TrackStartEvent, type TrackStuckEvent, TrackSymbol, type TremoloFilter, type UnresolvedQuery, type UnresolvedSearchResult, type UnresolvedTrack, type UnresolvedTrackInfo, UnresolvedTrackSymbol, type VersionObject, type VibratoFilter, type VoicePacket, type VoiceServer, type VoiceState, type WebSocketClosedEvent, type anyObject, audioOutputsData, parseLavalinkConnUrl, queueTrackEnd, safeStringify, validSponsorBlocks };