@types/REST
Table of contents
Type Aliases
- LavalinkRESTError
- LoadException
- LoadResultBase
- LoadTracksResult
- PlaylistData
- PlaylistLoadResult
- 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
LoadException
Ƭ LoadException: Object
Type declaration
Name | Type |
---|---|
message | string |
severity | "COMMON" | "SUSPIOUS" | "FAULT" |
Defined in
LoadResultBase
Ƭ LoadResultBase: Object
Type declaration
Name | Type |
---|---|
exception? | LoadException |
loadType | "track" | "playlist" | "search" | "empty" | "error" |
playlistInfo? | PlaylistInfo |
Defined in
LoadTracksResult
Ƭ LoadTracksResult: LoadResultBase
& { tracks
: ITrack
[] }
Defined in
PlaylistData
Ƭ PlaylistData: Object
Type declaration
Name | Type |
---|---|
info | PlaylistInfo |
pluginInfo | object |
tracks | ITrack [] |
Defined in
PlaylistLoadResult
Ƭ PlaylistLoadResult: Omit
\<LoadResultBase
, "loadType"
> & { data
: PlaylistData
; loadType
: "playlist"
}
Defined in
RequestOptions
Ƭ RequestOptions: Object
Type declaration
Name | Type |
---|---|
headers? | Record <string , string > |
json? | unknown |
method | Dispatcher.HttpMethod |
path | string |
Defined in
SearchResult
Ƭ SearchResult: LoadResultBase
& { tracks
: (Track
| UnresolvedTrack
)[] }
Defined in
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 | - |