Class Rest

A Rest helper for Lavalink

Hierarchy

Rest

Index

Methods

Methods

Static decode

decode(node: LavalinkNode, track: string): Promise<TrackData>
decode(node: LavalinkNode, tracks: string[]): Promise<TrackData[]>
decode(node: LavalinkNode, tracks: string | string[]): Promise<TrackData | TrackData[]>

- Defined in src/lib/Rest.ts:30
A helper for /decodetrack & /decodetracks

Parameters
- node: LavalinkNode
  
  The lavalink node
- track: string
  
  the track(s) you want to decode
Returns Promise<TrackData>
- Defined in src/lib/Rest.ts:31
Parameters
- node: LavalinkNode
- tracks: string[]
Returns Promise<TrackData[]>
- Defined in src/lib/Rest.ts:32
Parameters
- node: LavalinkNode
- tracks: string | string[]
Returns Promise<TrackData | TrackData[]>

Static load

load(node: LavalinkNode, identifer: string): Promise<TrackResponse>

- Defined in src/lib/Rest.ts:18
A helper for /loadtracks endpoint

Parameters
- node: LavalinkNode
  
  The LavalinkNode
- identifer: string
  
  The thing you want to load
Returns Promise<TrackResponse>

Static routePlannerStatus

routePlannerStatus(node: LavalinkNode): Promise<RoutePlannerStatus>

- Defined in src/lib/Rest.ts:47
A helper for /routeplanner/status

Parameters
- node: LavalinkNode
  
  The LavalinkNode
Returns Promise<RoutePlannerStatus>

Static routePlannerUnmark

routePlannerUnmark(node: LavalinkNode, address?: undefined | string): Promise<any>

- Defined in src/lib/Rest.ts:56
A helper for /routeplanner/free

Parameters
- node: LavalinkNode
  
  The LavalinkNode
- Optional address: undefined | string
  
  the address you want to free, this is optional
Returns Promise<any>

Generated using TypeDoc