lavalink-client 2.1.3 → 2.1.4

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

@@ -6,10 +6,6 @@ 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";
-export interface LavalinkManager {
-    nodeManager: NodeManager;
-    utils: ManagerUtils;
-}
 export interface BotClientOptions {
     /** Bot Client Id */
     id: string;
@@ -168,31 +164,186 @@ interface LavalinkManagerEvents {
     "ChaptersLoaded": (player: Player, track: Track | UnresolvedTrack, payload: SponsorBlockChaptersLoaded) => void;
 }
 export interface LavalinkManager {
-    options: ManagerOptions;
+    /** @private */
     on<U extends keyof LavalinkManagerEvents>(event: U, listener: LavalinkManagerEvents[U]): this;
+    /** @private */
     emit<U extends keyof LavalinkManagerEvents>(event: U, ...args: Parameters<LavalinkManagerEvents[U]>): boolean;
 }
 export declare class LavalinkManager extends EventEmitter {
-    static DefaultSources: Record<SearchPlatform, import("./Utils").LavalinkSearchPlatform | import("./Utils").ClientCustomSearchPlatformUtils>;
-    static SourceLinksRegexes: Record<import("./Utils").SourcesRegex, RegExp>;
+    /** The Options of LavalinkManager (changeable) */
+    options: ManagerOptions;
+    /** LavalinkManager's NodeManager to manage all Nodes */
+    nodeManager: NodeManager;
+    /** LavalinkManager's Utils Class */
+    utils: ManagerUtils;
+    /** Wether the manager was initiated or not */
     initiated: boolean;
+    /** All Players stored in a MiniMap */
     readonly players: MiniMap<string, Player>;
+    /**
+     * Applies the options provided by the User
+     * @param options
+     * @returns
+     */
     private applyOptions;
+    /**
+     * Validates the current manager's options
+     * @param options
+     */
     private validateOptions;
+    /**
+     * Create the Lavalink Manager
+     * @param options
+     *
+     * @example
+     * ```ts
+     * //const client = new Client({...}); // create your BOT Client (e.g. via discord.js)
+     * client.lavalink = new LavalinkManager({
+     *   nodes: [
+     *     {
+     *       authorization: "yourverystrongpassword",
+     *       host: "localhost",
+     *       port: 2333,
+     *       id: "testnode"
+     *     },
+     *     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",
+     *       volumeDecrementer: 0.75,
+     *       //requesterTransformer: YourRequesterTransformerFunction,
+     *       onDisconnect: {
+     *         autoReconnect: true,
+     *         destroyPlayer: false
+     *       },
+     *       onEmptyQueue: {
+     *         destroyAfterMs: 30_000,
+     *         //autoPlayFunction: YourAutoplayFunction,
+     *       },
+     *       useUnresolvedData: true
+     *     },
+     *     queueOptions: {
+     *       maxPreviousTracks: 25,
+     *       //queueStore: yourCustomQueueStoreManagerClass,
+     *       //queueChangesWatcher: yourCustomQueueChangesWatcherClass
+     *     },
+     *     linksBlacklist: [],
+     *     linksWhitelist: [],
+     *     advancedOptions: {
+     *       debugOptions: {
+     *         noAudio: false,
+     *         playerDestroy: {
+     *           dontThrowError: false,
+     *           debugLogs: false
+     *         }
+     *       }
+     *     }
+     *   ]
+     * })
+     * ```
+     */
     constructor(options: ManagerOptions);
-    createPlayer(options: PlayerOptions): Player;
+    /**
+     * Get a Player from Lava
+     * @param guildId The guildId of the player
+     *
+     * @example
+     * ```ts
+     * const player = client.lavalink.getPlayer(interaction.guildId);
+     * ```
+     * A quicker and easier way than doing:
+     * ```ts
+     * const player = client.lavalink.players.get(interaction.guildId);
+     * ```
+     * @returns
+     */
     getPlayer(guildId: string): Player;
+    /**
+     * Create a Music-Player. If a player exists, then it returns it before creating a new one
+     * @param options
+     * @returns
+     *
+     * @example
+     * ```ts
+     * const player = client.lavalink.createPlayer({
+     *   guildId: interaction.guildId,
+     *   voiceChannelId: interaction.member.voice.channelId,
+     *   // everything below is optional
+     *   textChannelId: interaction.channelId,
+     *   volume: 100,
+     *   selfDeaf: true,
+     *   selfMute: false,
+     *   instaUpdateFiltersFix: true,
+     *   applyVolumeAsFilter: false
+     *   //only needed if you want to autopick node by region (configured by you)
+     *   // vcRegion: interaction.member.voice.rtcRegion,
+     *   // provide a specific node
+     *   // node: client.lavalink.nodeManager.leastUsedNodes("memory")[0]
+     * });
+     * ```
+     */
+    createPlayer(options: PlayerOptions): Player;
+    /**
+     * Destroy a player with optional destroy reason and disconnect it from the voice channel
+     * @param guildId
+     * @param destroyReason
+     * @returns
+     *
+     * @example
+     * ```ts
+     * client.lavalink.destroyPlayer(interaction.guildId, "forcefully destroyed the player");
+     * // recommend to do it on the player tho: player.destroy("forcefully destroyed the player");
+     * ```
+     */
     destroyPlayer(guildId: string, destroyReason?: string): Promise<Player>;
+    /**
+     * Delete's a player from the cache without destroying it on lavalink (only works when it's disconnected)
+     * @param guildId
+     * @returns
+     */
     deletePlayer(guildId: string): boolean;
+    /**
+     * Checks wether the the lib is useable based on if any node is connected
+     */
     get useable(): boolean;
     /**
-     * Initiates the Manager.
+     * Initiates the Manager, creates all nodes and connects all of them
      * @param clientData
+     *
+     * @example
+     *
+     * ```ts
+     * // on the bot ready event
+     * client.on("ready", () => {
+     *   client.lavalink.init({
+     *     id: client.user.id,
+     *     username: client.user.username
+     *   });
+     * });
+     * ```
      */
     init(clientData: BotClientOptions): Promise<this>;
     /**
      * Sends voice data to the Lavalink server.
+     * ! Without this the library won't work
      * @param data
+     *
+     * @example
+     *
+     * ```ts
+     * // on the bot "raw" event
+     * client.on("raw", (d) => {
+     *   // required in order to send audio updates and register channel deletion etc.
+     *   client.lavalink.sendRawData(d)
+     * })
+     * ```
      */
     sendRawData(data: VoicePacket | VoiceServer | VoiceState | ChannelDeletePacket): Promise<void>;
 }

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

@@ -172,7 +172,7 @@ export declare class Player {
      * @param query Query for your data
      * @param requestUser
      */
-    search(query: SearchQuery, requestUser: unknown): Promise<import("./Utils").UnresolvedSearchResult | import("./Utils").SearchResult>;
+    search(query: SearchQuery, requestUser: unknown): Promise<import("./Utils").SearchResult | import("./Utils").UnresolvedSearchResult>;
     /**
      * Pause the player
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lavalink-client",
-  "version": "2.1.3",
+  "version": "2.1.4",
   "description": "Easy, flexible and feature-rich lavalink@v4 Client. Both for Beginners and Proficients.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -14,7 +14,8 @@
     "lint": "eslint .",
     "lint:fix": "eslint --fix 'src/**/*.{ts}'",
     "format": "prettier --write src/**/*.ts --config ./.prettierrc.js",
-    "test": "node -v"
+    "test": "node -v",
+    "docs": "npx typedoc"
   },
   "publishConfig": {
     "access": "public"
@@ -54,6 +55,8 @@
     "eslint": "^8.47.0",
     "ts-loader": "^9.4.4",
     "tslib": "^2.6.1",
+    "typedoc": "^0.25.4",
+    "typedoc-theme-hierarchy": "^4.1.2",
     "typescript": "^5.1.6"
   },
   "dependencies": {