Rest

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export class Rest {}

Properties

Property	Type	Description
isNodeLink	boolean	Whether the connected node is a NodeLink node.
manager	Manager	The Manager instance.

Constructor

new Rest(node: Node, manager: Manager)

Parameter	Type	Description	Optional
node	Node	The node instance.
manager	Manager	The manager instance.

Methods

delete()

async delete(endpoint: string): Promise<unknown>

Sends a DELETE request to the specified endpoint.

Parameters

Parameter	Type	Description	Optional
endpoint	string	The endpoint path.

Returns

Type	Description
Promise<unknown>	The response data.

---

destroyPlayer()

async destroyPlayer(guildId: string): Promise<unknown>

Sends a DELETE request to the Lavalink session to destroy the player for the given guild.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild ID of the player to destroy.

Returns

Type	Description
Promise<unknown>	The response data.

---

get()

async get(endpoint: string): Promise<unknown>

Sends a GET request to the specified endpoint.

Parameters

Parameter	Type	Description	Optional
endpoint	string	The endpoint path.

Returns

Type	Description
Promise<unknown>	The response data.

---

getPlayer()

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

Fetches the current Lavalink player state for the given guild from the active session.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild ID.

Returns

Type	Description
Promise<LavaPlayer>	The raw Lavalink player object.

---

patch()

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

Sends a PATCH request to the specified endpoint.

Parameters

Parameter	Type	Description	Optional
endpoint	string	The endpoint path.
body	unknown	The request body.

Returns

Type	Description
Promise<unknown>	The response data.

---

post()

async post(endpoint: string, body: unknown): Promise<unknown>

Sends a POST request to the specified endpoint.

Parameters

Parameter	Type	Description	Optional
endpoint	string	The endpoint path.
body	unknown	The request body.

Returns

Type	Description
Promise<unknown>	The response data.

---

put()

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

Sends a PUT request to the specified endpoint.

Parameters

Parameter	Type	Description	Optional
endpoint	string	The endpoint path.
body	unknown	The request body.

Returns

Type	Description
Promise<unknown>	The response data.

---

setSessionId()

setSessionId(sessionId: string): string

Updates the active session ID. Called internally after a session resume.

Parameters

Parameter	Type	Description	Optional
sessionId	string	The new session ID.

Returns

Type	Description
string	The set session ID.

---

updatePlayer()

async updatePlayer(options: RestPlayOptions): Promise<unknown>

Sends a PATCH request to update the Lavalink player state for the given guild.

Parameters

Parameter	Type	Description	Optional
options	RestPlayOptions	The player update options.

Returns

Type	Description
Promise<unknown>	The response data.

---

updateSession()

async updateSession(resuming: boolean, timeout: number): Promise<unknown>

Sends a PATCH request to update the session's resume configuration on the Lavalink node.

Parameters

Parameter	Type	Description	Optional
resuming	boolean	Whether the session should be configured for resuming.
timeout	number	The resume timeout in seconds.

Returns

Type	Description
Promise<unknown>	The response data.