@types/REST

Table of contents

Type Aliases

• LavalinkRESTError
• LoadException
• LoadResultBase
• LoadTracksResult
• RequestOptions
• SearchResult
• UpdatePlayerOptions

Type Aliases

LavalinkRESTError

Ƭ LavalinkRESTError: Object

Type declaration

Name	Type
error	string
message	string
path	string
status	number
timestamp	number
trace?	string

Defined in

@types/REST.types.ts:24

---

LoadException

Ƭ LoadException: Object

Type declaration

Name	Type
message	string
severity	"COMMON" | "SUSPIOUS" | "FAULT"

Defined in

@types/REST.types.ts:40

---

LoadResultBase

Ƭ LoadResultBase: Object

Type declaration

Name	Type
exception?	LoadException
loadType	"TRACK_LOADED" | "PLAYLIST_LOADED" | "SEARCH_RESULT" | "NO_MATCHES" | "LOAD_FAILED"
playlistInfo	PlaylistInfo

Defined in

@types/REST.types.ts:45

---

LoadTracksResult

Ƭ LoadTracksResult: LoadResultBase & { tracks: ITrack[] }

Defined in

@types/REST.types.ts:51

---

RequestOptions

Ƭ RequestOptions: Object

Type declaration

Name	Type
headers?	Record<string, string>
json?	unknown
method	Dispatcher.HttpMethod
path	string

Defined in

@types/REST.types.ts:33

---

SearchResult

Ƭ SearchResult: LoadResultBase & { tracks: (Track | UnresolvedTrack)[] }

Defined in

@types/REST.types.ts:55

---

UpdatePlayerOptions

Ƭ UpdatePlayerOptions: Object

Type declaration

Name	Type	Description
encodedTrack?	string | null	-
endTime?	number	-
filters?	FilterOptions	-
noReplace?	boolean	-
paused?	boolean	-
position?	number	identifier?: string;
voice?	{ endpoint: string ; sessionId: string ; token: string }	-
voice.endpoint	string	-
voice.sessionId	string	-
voice.token	string	-
volume?	number	-

Defined in

@types/REST.types.ts:8