Class Rest

Wrapper around Lavalink REST API

Index

Constructors

Properties

Accessors

Methods

decode destroyPlayer fetch getLavalinkInfo getPlayer getPlayers getRoutePlannerStatus resolve stats unmarkFailedAddress updatePlayer updateSession

Constructors

constructor

new Rest(node: Node, options: NodeOption): Rest
Parameters
- node: Node
  An instance of Node
- options: NodeOption
  The options to initialize this rest class
  - auth: string
    Credentials to access Lavalink
  - Optionalgroup?: string
    Name of the Lavalink node group
  - name: string
    Name of the Lavalink node
  - Optionalsecure?: boolean
    Whether to use secure protocols or not
  - url: string
    Lavalink node host and port without any prefix
Returns Rest
- Defined in src/node/Rest.ts:58

Properties

`Protected` `Readonly`auth

auth: string

Credentials to access Lavalink

`Protected` `Readonly`node

node: Node

Node that initialized this instance

`Protected` `Readonly`url

url: string

URL of Lavalink

Accessors

`Protected`sessionId

get sessionId(): string
Returns string
- Defined in src/node/Rest.ts:64

Methods

decode

decode(track: string): Promise<Track>
Decode a track
Parameters
- track: string
  Encoded track
Returns Promise<Track>
Promise that resolves to a track
- Defined in src/node/Rest.ts:87

destroyPlayer

destroyPlayer(guildId: string): Promise<void>
Deletes a Lavalink player
Parameters
- guildId: string
  guildId where this player is
Returns Promise<void>
- Defined in src/node/Rest.ts:147

`Protected`fetch

fetch<T = unknown>(fetchOptions: FetchOptions): Promise<undefined | T>
Internal
Make a request to Lavalink
Type Parameters
- T = unknown
Parameters
- fetchOptions: FetchOptions
  - endpoint
    Lavalink endpoint
  - options
    Options passed to fetch
Returns Promise<undefined | T>
Throws
RestError when encountering a Lavalink error response
- Defined in src/node/Rest.ts:239

getLavalinkInfo

getLavalinkInfo(): Promise<NodeInfo>
Get Lavalink info

Returns Promise<NodeInfo>
- Defined in src/node/Rest.ts:221

getPlayer

getPlayer(guildId: string): Promise<LavalinkPlayer>
Gets the player with the specified guildId
Parameters
- guildId: string
Returns Promise<LavalinkPlayer>
Promise that resolves to a Lavalink player
- Defined in src/node/Rest.ts:113

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:100

getRoutePlannerStatus

getRoutePlannerStatus(): Promise<RoutePlanner>
Get routeplanner status from Lavalink

Returns Promise<RoutePlanner>
Promise that resolves to a routeplanner response
- Defined in src/node/Rest.ts:192

resolve

resolve(identifier: string): Promise<LavalinkResponse>
Resolve a track
Parameters
- identifier: string
  Track ID
Returns Promise<LavalinkResponse>
A promise that resolves to a Lavalink response
- Defined in src/node/Rest.ts:73

stats

stats(): Promise<Stats>
Gets the status of this node

Returns Promise<Stats>
Promise that resolves to a node stats response
- Defined in src/node/Rest.ts:179

unmarkFailedAddress

unmarkFailedAddress(address: string): Promise<void>
Release blacklisted IP address into pool of IPs
Parameters
- address: string
  IP address
Returns Promise<void>
- Defined in src/node/Rest.ts:205

updatePlayer

updatePlayer(
    guildId: string,
    updatePlayerOptions: UpdatePlayerOptions,
    noReplace?: boolean,
): Promise<LavalinkPlayer>
Updates a Lavalink player
Parameters
- guildId: string
  GuildId of the player you want to update
- updatePlayerOptions: UpdatePlayerOptions
  Data to update on the player
- noReplace: boolean = false
  If you want this action to do nothing when the player is active
Returns Promise<LavalinkPlayer>
Promise that resolves to a Lavalink player
- Defined in src/node/Rest.ts:129

updateSession

updateSession(resuming?: boolean, timeout?: number): Promise<SessionInfo>
Updates the session with a resume boolean and timeout
Parameters
- Optionalresuming: boolean
  Whether resuming is enabled for this session or not
- Optionaltimeout: number
  Timeout to wait for resuming
Returns Promise<SessionInfo>
Promise that resolves to a Lavalink player
- Defined in src/node/Rest.ts:162