for-modules 1.0.0

package/dist/Structures/Node.d.ts

@@ -0,0 +1,140 @@
+import { PlayerEvent, PlayerEvents, TrackEndEvent, TrackExceptionEvent, TrackStartEvent, TrackStuckEvent, WebSocketClosedEvent } from "./Utils";
+import { Manager } from "./Manager";
+import { Player, Track, UnresolvedTrack } from "./Player";
+import { Rest } from "./Rest";
+import WebSocket from "ws";
+export declare class Node {
+    options: NodeOptions;
+    /** The socket for the node. */
+    socket: WebSocket | null;
+    /** The stats for the node. */
+    stats: NodeStats;
+    manager: Manager;
+    /** The node's session ID. */
+    sessionId: string | null;
+    /** The REST instance. */
+    readonly rest: Rest;
+    private static _manager;
+    private reconnectTimeout?;
+    private reconnectAttempts;
+    /** Returns if connected to the Node. */
+    get connected(): boolean;
+    /** Returns the address for this node. */
+    get address(): string;
+    /** @hidden */
+    static init(manager: Manager): void;
+    /**
+     * Creates an instance of Node.
+     * @param options
+     */
+    constructor(options: NodeOptions);
+    /** Connects to the Node. */
+    connect(): void;
+    /** Destroys the Node and all players connected with it. */
+    destroy(): void;
+    private reconnect;
+    protected open(): void;
+    protected close(code: number, reason: string): void;
+    protected error(error: Error): void;
+    protected message(d: Buffer | string): void;
+    protected handleEvent(payload: PlayerEvent & PlayerEvents): Promise<void>;
+    protected trackStart(player: Player, track: Track, payload: TrackStartEvent): void;
+    protected trackEnd(player: Player, track: Track, payload: TrackEndEvent): Promise<void>;
+    extractSpotifyTrackID(url: string): string | null;
+    extractSpotifyArtistID(url: string): string | null;
+    private handleAutoplay;
+    private handleFailedTrack;
+    private handleRepeatedTrack;
+    private playNextTrack;
+    protected queueEnd(player: Player, track: Track, payload: TrackEndEvent): Promise<void>;
+    protected trackStuck(player: Player, track: Track, payload: TrackStuckEvent): void;
+    protected trackError(player: Player, track: Track | UnresolvedTrack, payload: TrackExceptionEvent): void;
+    protected socketClosed(player: Player, payload: WebSocketClosedEvent): void;
+}
+export interface NodeOptions {
+    /** The host for the node. */
+    host: string;
+    /** The port for the node. */
+    port?: number;
+    /** The password for the node. */
+    password?: string;
+    /** Whether the host uses SSL. */
+    secure?: boolean;
+    /** The identifier for the node. */
+    identifier?: string;
+    /** The retryAmount for the node. */
+    retryAmount?: number;
+    /** The retryDelay for the node. */
+    retryDelay?: number;
+    /** Whether to resume the previous session. */
+    resumeStatus?: boolean;
+    /** The time the manager will wait before trying to resume the previous session. */
+    resumeTimeout?: number;
+    /** The timeout used for api calls. */
+    requestTimeout?: number;
+    /** Priority of the node. */
+    priority?: number;
+}
+export interface NodeStats {
+    /** The amount of players on the node. */
+    players: number;
+    /** The amount of playing players on the node. */
+    playingPlayers: number;
+    /** The uptime for the node. */
+    uptime: number;
+    /** The memory stats for the node. */
+    memory: MemoryStats;
+    /** The cpu stats for the node. */
+    cpu: CPUStats;
+    /** The frame stats for the node. */
+    frameStats: FrameStats;
+}
+export interface MemoryStats {
+    /** The free memory of the allocated amount. */
+    free: number;
+    /** The used memory of the allocated amount. */
+    used: number;
+    /** The total allocated memory. */
+    allocated: number;
+    /** The reservable memory. */
+    reservable: number;
+}
+export interface CPUStats {
+    /** The core amount the host machine has. */
+    cores: number;
+    /** The system load. */
+    systemLoad: number;
+    /** The lavalink load. */
+    lavalinkLoad: number;
+}
+export interface FrameStats {
+    /** The amount of sent frames. */
+    sent?: number;
+    /** The amount of nulled frames. */
+    nulled?: number;
+    /** The amount of deficit frames. */
+    deficit?: number;
+}
+export interface LavalinkInfo {
+    version: {
+        semver: string;
+        major: number;
+        minor: number;
+        patch: number;
+        preRelease: string;
+    };
+    buildTime: number;
+    git: {
+        branch: string;
+        commit: string;
+        commitTime: number;
+    };
+    jvm: string;
+    lavaplayer: string;
+    sourceManagers: string[];
+    filters: string[];
+    plugins: {
+        name: string;
+        version: string;
+    }[];
+}