LithiumX / LithiumXRest
Class: LithiumXRest
Defined in: src/Structures/Rest.ts:4
Handles the requests sent to the Lavalink REST API.
Constructors
new LithiumXRest()
new LithiumXRest(
node):LithiumXRest
Defined in: src/Structures/Rest.ts:12
Parameters
node
Returns
LithiumXRest
Methods
delete()
delete(
endpoint):Promise<unknown>
Defined in: src/Structures/Rest.ts:85
Parameters
endpoint
string
Returns
Promise<unknown>
destroyPlayer()
destroyPlayer(
guildId):Promise<unknown>
Defined in: src/Structures/Rest.ts:38
Sends a DELETE request to the server to destroy the player.
Parameters
guildId
string
Returns
Promise<unknown>
get()
get(
endpoint):Promise<unknown>
Defined in: src/Structures/Rest.ts:70
Parameters
endpoint
string
Returns
Promise<unknown>
getAllPlayers()
getAllPlayers():
Promise<unknown>
Defined in: src/Structures/Rest.ts:28
Retrieves all the players that are currently running on the node.
Returns
Promise<unknown>
patch()
patch(
endpoint,body):Promise<unknown>
Defined in: src/Structures/Rest.ts:75
Parameters
endpoint
string
body
unknown
Returns
Promise<unknown>
post()
post(
endpoint,body):Promise<unknown>
Defined in: src/Structures/Rest.ts:80
Parameters
endpoint
string
body
unknown
Returns
Promise<unknown>
setSessionId()
setSessionId(
sessionId):string
Defined in: src/Structures/Rest.ts:22
Sets the session ID.
Parameters
sessionId
string
Returns
string
Returns the session ID.
updatePlayer()
updatePlayer(
options):Promise<unknown>
Defined in: src/Structures/Rest.ts:33
Sends a PATCH request to update player related data.
Parameters
options
playOptions
Returns
Promise<unknown>