Rest

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export class Rest {}

Properties

Property	Type	Description
isNodeLink	boolean	Whether the Rest instance is a NodeLink instance.
manager	Manager	The manager instance.
node	Node	The node instance.
password	string	The password used to connect to the node.
sessionId	string	The session ID.
url	string	The URI of the node.

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 to delete.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

destroyPlayer()

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

Sends a DELETE request to the server to destroy the player.

Parameters

Parameter	Type	Description	Optional
guildId	string	The guild ID.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

get()

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

Sends a GET request to the specified endpoint.

Parameters

Parameter	Type	Description	Optional
endpoint	string	The endpoint to get.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

getAllPlayers()

async getAllPlayers(): Promise<unknown>

Sends a GET request to the server to get all players.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

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 to patch.
body	unknown	The body to patch.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

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 to post.
body	unknown	The body to post.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

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 to put.
body	unknown	The body to put.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

setSessionId()

setSessionId(sessionId: string): string

Sets the session ID.

Parameters

Parameter	Type	Description	Optional
sessionId	string	The session ID to set.

Returns

Return	Description
string	The session ID.

---

updatePlayer()

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

Sends a PATCH request to the server to update the player.

Parameters

Parameter	Type	Description	Optional
options	RestPlayOptions	The options to update.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.

---

updateSession()

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

Sends a PATCH request to update the session's resuming status and timeout.

Parameters

Parameter	Type	Description	Optional
resuming	boolean	Whether the session is resuming.
timeout	number	The session timeout.

Returns

Return	Description
Promise<unknown>	The promise that resolves to the response.