Class REST

Functional class for interacting with lavalink's REST API

Index

Constructors

Properties

origin version timeout baseUrl

Accessors

sessionId userAgent

Methods

request get post patch delete loadTracks decodeTrack decodeTracks fetchPlayers fetchPlayer updatePlayer destroyPlayer updateSession fetchInfo fetchStats fetchRoutePlannerStatus unmarkFailedAddress unmarkAllFailedAddresses

Constructors

constructor

new REST(options: RESTOptions): REST
Parameters
- options: RESTOptions
Returns REST
- Defined in node/rest.ts:46

Properties

`Readonly`origin

origin: string

`Readonly`version

version: number

`Readonly`timeout

timeout: number

`Readonly`baseUrl

baseUrl: string

Accessors

sessionId

get sessionId(): string | null
Returns string | null
- Defined in node/rest.ts:91
set sessionId(id: string | null): void
Parameters
- id: string | null
Returns void
- Defined in node/rest.ts:99

userAgent

get userAgent(): string
Returns string
- Defined in node/rest.ts:95

Methods

request

request<T>(endpoint: string, options?: RequestOptions): Promise<RestResponse<T>>
Type Parameters
- T
Parameters
- endpoint: string
- Optionaloptions: RequestOptions
Returns Promise<RestResponse<T>>
- Defined in node/rest.ts:117

get

get<T>(
endpoint: string,
options?: Omit<RequestOptions, "data" | "method">,
): Promise<RestResponse<T>>
Type Parameters
- T
Parameters
- endpoint: string
- Optionaloptions: Omit<RequestOptions, "data" | "method">
Returns Promise<RestResponse<T>>
- Defined in node/rest.ts:177

post

post<T>(
endpoint: string,
options?: Omit<RequestOptions, "method">,
): Promise<RestResponse<T>>
Type Parameters
- T
Parameters
- endpoint: string
- Optionaloptions: Omit<RequestOptions, "method">
Returns Promise<RestResponse<T>>
- Defined in node/rest.ts:181

patch

patch<T>(
endpoint: string,
options?: Omit<RequestOptions, "method">,
): Promise<RestResponse<T>>
Type Parameters
- T
Parameters
- endpoint: string
- Optionaloptions: Omit<RequestOptions, "method">
Returns Promise<RestResponse<T>>
- Defined in node/rest.ts:185

delete

delete<T>(
endpoint: string,
options?: Omit<RequestOptions, "method">,
): Promise<RestResponse<T>>
Type Parameters
- T
Parameters
- endpoint: string
- Optionaloptions: Omit<RequestOptions, "method">
Returns Promise<RestResponse<T>>
- Defined in node/rest.ts:189

loadTracks

loadTracks(identifier: string): Promise<LoadResult>
Parameters
- identifier: string
Returns Promise<LoadResult>
- Defined in node/rest.ts:193

decodeTrack

decodeTrack(
encodedTrack: string,
): Promise<APITrack<CommonUserData, CommonPluginInfo>>
Parameters
- encodedTrack: string
Returns Promise<APITrack<CommonUserData, CommonPluginInfo>>
- Defined in node/rest.ts:199

decodeTracks

decodeTracks(
tracks: string[],
): Promise<APITrack<CommonUserData, CommonPluginInfo>[]>
Parameters
- tracks: string[]
Returns Promise<APITrack<CommonUserData, CommonPluginInfo>[]>
- Defined in node/rest.ts:205

fetchPlayers

fetchPlayers(sessionId?: string): Promise<APIPlayer[]>
Parameters
- sessionId: string = ...
Returns Promise<APIPlayer[]>
- Defined in node/rest.ts:211

fetchPlayer

fetchPlayer(guildId: string, sessionId?: string): Promise<APIPlayer>
Parameters
- guildId: string
- sessionId: string = ...
Returns Promise<APIPlayer>
- Defined in node/rest.ts:217

updatePlayer

updatePlayer(
    guildId: string,
    options: PlayerUpdateRequestBody,
    params?: PlayerUpdateQueryParams,
    sessionId?: string,
): Promise<APIPlayer>
Parameters
- guildId: string
- options: PlayerUpdateRequestBody
- Optionalparams: PlayerUpdateQueryParams
- sessionId: string = ...
Returns Promise<APIPlayer>
- Defined in node/rest.ts:224

destroyPlayer

destroyPlayer(guildId: string, sessionId?: string): Promise<boolean>
Parameters
- guildId: string
- sessionId: string = ...
Returns Promise<boolean>
- Defined in node/rest.ts:241

updateSession

updateSession(
options: SessionUpdateRequestBody,
sessionId?: string,
): Promise<Required<SessionUpdateRequestBody>>
Parameters
- options: SessionUpdateRequestBody
- sessionId: string = ...
Returns Promise<Required<SessionUpdateRequestBody>>
- Defined in node/rest.ts:248

fetchInfo

fetchInfo(): Promise<LavalinkInfo>
Returns Promise<LavalinkInfo>
- Defined in node/rest.ts:258

fetchStats

fetchStats(): Promise<NodeStats>
Returns Promise<NodeStats>
- Defined in node/rest.ts:263

fetchRoutePlannerStatus

fetchRoutePlannerStatus(): Promise<RoutePlannerStatus>
Returns Promise<RoutePlannerStatus>
- Defined in node/rest.ts:268

unmarkFailedAddress

unmarkFailedAddress(address: string): Promise<boolean>
Parameters
- address: string
Returns Promise<boolean>
- Defined in node/rest.ts:274

unmarkAllFailedAddresses

unmarkAllFailedAddresses(): Promise<boolean>
Returns Promise<boolean>
- Defined in node/rest.ts:280