Skip to main content
Version: v2.10.3

Rest

Provides authenticated HTTP helpers for shared endpoints and guarded native NodeLink endpoints.

Signatures below match the public source surface in 2.10.3. Use manager/player factories for ordinary application setup.

Constructor​

constructor(node: Node, manager: Manager);

Properties​

Property or getterDeclaration
managerpublic manager: Manager
isNodeLinkpublic isNodeLink: boolean = false

Methods​

setSessionId​

public setSessionId(sessionId: string): string;

Sets the session ID.

getPlayer​

public async getPlayer(guildId: string): Promise<LavaPlayer>;

Fetches a remote player. Currently returns null at runtime with no session despite its declared non-null result type.

getPlayers​

public async getPlayers(): Promise<LavaPlayer[]>;

Lists this session's remote players. With no session returns []; HTTP-400 fallback only requests locally known players on this node.

updatePlayer​

public async updatePlayer(options: RestPlayOptions): Promise<LavaPlayer>;

Updates a remote player; guards native fields on Lavalink. Currently returns null at runtime without a session.

destroyPlayer​

public async destroyPlayer(guildId: string): Promise<void>;

Deletes a remote player, or does nothing when no session is available.

updateSession​

public async updateSession(resuming: boolean, timeout: number): Promise<LavalinkSession>;

Updates resumption settings; currently returns null at runtime without a session.

decodeTrack​

public async decodeTrack(encodedTrack: string): Promise<TrackData>;

Decodes a single Lavalink track.

decodeTracks​

public async decodeTracks(encodedTracks: string[]): Promise<TrackData[]>;

Sends a JSON array to the decode endpoint and normalizes an array or NodeLink { tracks } response.

getInfo​

public async getInfo(): Promise<LavalinkInfo>;

Retrieves this node's Lavalink info.

getStats​

public async getStats(): Promise<NodeStats>;

Loads stats and supplies a Lavalink-load fallback from NodeLink's nodelinkLoad field.

getNodeLinkConnection​

public async getNodeLinkConnection(): Promise<NodeLinkConnectionInfo>;

Returns NodeLink connection diagnostics.

encodeNodeLinkTrack​

public async encodeNodeLinkTrack(track: NodeLinkTrackEncodeInput): Promise<string>;

Encodes one track info payload using NodeLink.

encodeNodeLinkTracks​

public async encodeNodeLinkTracks(tracks: NodeLinkTrackEncodeInput[]): Promise<string[]>;

Encodes multiple track info payloads using NodeLink.

getNodeLinkMeaning​

public async getNodeLinkMeaning(encodedTrack: string, language: string = "en"): Promise<NodeLinkMeaningResult>;

Loads NodeLink meaning/background information for an encoded track.

getNodeLinkTrackStream​

public async getNodeLinkTrackStream(encodedTrack: string, itag?: number): Promise<NodeLinkTrackStreamResult>;

Resolves NodeLink's direct stream URL and format metadata.

loadNodeLinkPcmStream​

public async loadNodeLinkPcmStream(encodedTrack: string, options: NodeLinkLoadStreamOptions = {}): Promise<UndiciResponse>;

Opens an Undici Response for raw PCM. Consume or cancel response.body; the request timeout does not cover the full body duration.

getRoutePlannerStatus​

public async getRoutePlannerStatus(): Promise<RoutePlannerStatus>;

Retrieves the route planner status.

freeRoutePlannerAddress​

public async freeRoutePlannerAddress(address: string): Promise<void>;

Unmarks a failed route planner address.

freeAllRoutePlannerAddresses​

public async freeAllRoutePlannerAddresses(): Promise<void>;

Unmarks all failed route planner addresses.

get​

public async get<T>(endpoint: string): Promise<T>;

Sends a GET request to the specified endpoint and returns the response data.

patch​

public async patch<T>(endpoint: string, body: unknown): Promise<T>;

Sends a PATCH request to the specified endpoint and returns the response data.

post​

public async post<T>(endpoint: string, body?: unknown): Promise<T>;

Sends a POST request to the specified endpoint and returns the response data.

put​

public async put<T>(endpoint: string, body: unknown): Promise<T>;

Sends a PUT request to the specified endpoint and returns the response data.

delete​

public async delete(endpoint: string): Promise<void>;

Sends a DELETE request to the specified endpoint.

Types and Guides​