Rest

readonly url: string;

The URL for the REST.

readonly version: string;

The version for the REST.

readonly restTimeout: number;

The timeout for the REST.

readonly userAgent: UserAgent;

The user agent for the REST.

readonly node: NodeStructure;

The node for the REST.

get restUrl(): string;

The REST URL to make requests.

get sessionId(): string | null;

The session id of the node.

constructor(node: NodeStructure);

request<T>(options: RestOptions): Promise<T | null>;

Make a request to the node.

updatePlayer(data: Partial<UpdatePlayerInfo>): Promise<LavalinkPlayer | null>;

Update the player data.

const player = await node.rest.updatePlayer({
	guildId: "guildId",
	noReplace: true,
	playerOptions: {
		paused: false,
		track: { encoded: "encoded track" },
	},
});

console.log(player); // The updated lavalink player data

stopPlayer(guildId: string): Promise<LavalinkPlayer | null>;

Stop the track in player for the guild.

const player = await node.rest.stopPlayer("guildId");
if (player) console.log(player); // The lavalink player

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

Destroy the player for the guild.

await node.rest.destroyPlayer("guildId");

updateSession(options: SessionResumingOptions): Promise<LavalinkSession | null>;

Update the session for the node

const session = await node.rest.updateSession({ resuming: true, timeout: 30000 });
if (session) console.log(session); // The lavalink session data

getPlayers(): Promise<LavalinkPlayer[]>;

Get all players for the current session.

const players = await node.rest.getPlayers();
console.log(players); // The lavalink players for the current session