Rest

Wrapper around Lavalink REST API

Constructors

new Rest()

new Rest(node, options): Rest

Parameters

• node: Node

An instance of Node

• options: NodeOption

The options to initialize this rest class

Returns

Rest

Defined in

src/node/Rest.ts:187

Methods

decode()

decode(track): Promise<undefined | Track>

Decode a track

Parameters

• track: string

Encoded track

Returns

Promise<undefined | Track>

Promise that resolves to a track

Defined in

src/node/Rest.ts:216

---

destroyPlayer()

destroyPlayer(guildId): Promise<void>

Deletes a Lavalink player

Parameters

• guildId: string

guildId where this player is

Returns

Promise<void>

Defined in

src/node/Rest.ts:270

---

getLavalinkInfo()

getLavalinkInfo(): Promise<undefined | NodeInfo>

Get Lavalink info

Returns

Promise<undefined | NodeInfo>

Defined in

src/node/Rest.ts:339

---

getPlayer()

getPlayer(guildId): Promise<undefined | LavalinkPlayer>

Gets all the player with the specified sessionId

Parameters

• guildId: string

Returns

Promise<undefined | LavalinkPlayer>

Promise that resolves to an array of Lavalink players

Defined in

src/node/Rest.ts:240

---

getPlayers()

getPlayers(): Promise<LavalinkPlayer[]>

Gets all the player with the specified sessionId

Returns

Promise<LavalinkPlayer[]>

Promise that resolves to an array of Lavalink players

Defined in

src/node/Rest.ts:228

---

getRoutePlannerStatus()

getRoutePlannerStatus(): Promise<undefined | RoutePlanner>

Get routeplanner status from Lavalink

Returns

Promise<undefined | RoutePlanner>

Promise that resolves to a routeplanner response

Defined in

src/node/Rest.ts:312

---

resolve()

resolve(identifier): Promise<undefined | LavalinkResponse>

Resolve a track

Parameters

• identifier: string

Track ID

Returns

Promise<undefined | LavalinkResponse>

A promise that resolves to a Lavalink response

Defined in

src/node/Rest.ts:203

---

stats()

stats(): Promise<undefined | NodeStats>

Gets the status of this node

Returns

Promise<undefined | NodeStats>

Promise that resolves to a node stats response

Defined in

src/node/Rest.ts:300

---

unmarkFailedAddress()

unmarkFailedAddress(address): Promise<void>

Release blacklisted IP address into pool of IPs

Parameters

• address: string

IP address

Returns

Promise<void>

Defined in

src/node/Rest.ts:324

---

updatePlayer()

updatePlayer(data): Promise<undefined | LavalinkPlayer>

Updates a Lavalink player

Parameters

• data: UpdatePlayerInfo

SessionId from Discord

Returns

Promise<undefined | LavalinkPlayer>

Promise that resolves to a Lavalink player

Defined in

src/node/Rest.ts:253

---

updateSession()

updateSession(resuming?, timeout?): Promise<undefined | SessionInfo>

Updates the session with a resume boolean and timeout

Parameters

• resuming?: boolean

Whether resuming is enabled for this session or not

• timeout?: number

Timeout to wait for resuming

Returns

Promise<undefined | SessionInfo>

Promise that resolves to a Lavalink player

Defined in

src/node/Rest.ts:284