Class REST

constructor

• new REST(options: RESTOptions): REST

  Parameters

  • options: RESTOptions

  Returns REST

Readonlyorigin

Readonlyversion

timeout

• get timeout(): number

  Timeout per request in milliseconds

  Returns number

• set timeout(ms: number): void

  Parameters

  • ms: number

  Returns void

sessionId

• get sessionId(): string | null

  Id of a session if set. Setting this has no effect if this instance belongs to a Node

  Returns string | null

• set sessionId(id: string | null): void

  Parameters

  • id: string | null

  Returns void

retryLimit

• get retryLimit(): number

  Retry limit of timed-out requests

  Returns number

• set retryLimit(count: number): void

  Parameters

  • count: number

  Returns void

dropSessionRequests

• dropSessionRequests(reason: string): void

  Parameters

  • reason: string

  Returns void

request

• request<
      T,
      Data extends JsonLike = EmptyObject,
      Params extends JsonLike = EmptyObject,
  >(
      method: Method,
      endpoint: string,
      options?: RequestOptions<Data, Params>,
  ): Promise<AxiosResponse<T, Data, {}>>

  Type Parameters

  • T
  • Data extends JsonLike = EmptyObject
  • Params extends JsonLike = EmptyObject

  Parameters

  • method: Method
  • endpoint: string
  • Optionaloptions: RequestOptions<Data, Params>

  Returns Promise<AxiosResponse<T, Data, {}>>

get

• get<T, P extends JsonLike>(
      endpoint: string,
      options?: Omit<RequestOptions<never, P>, "data">,
  ): Promise<AxiosResponse<T, never, {}>>

  Type Parameters

  • T
  • P extends JsonLike

  Parameters

  • endpoint: string
  • Optionaloptions: Omit<RequestOptions<never, P>, "data">

  Returns Promise<AxiosResponse<T, never, {}>>

post

• post<T, D extends JsonLike, P extends JsonLike>(
      endpoint: string,
      options?: RequestOptions<D, P>,
  ): Promise<AxiosResponse<T, D, {}>>

  Type Parameters

  • T
  • D extends JsonLike
  • P extends JsonLike

  Parameters

  • endpoint: string
  • Optionaloptions: RequestOptions<D, P>

  Returns Promise<AxiosResponse<T, D, {}>>

patch

• patch<T, D extends JsonLike, P extends JsonLike>(
      endpoint: string,
      options?: RequestOptions<D, P>,
  ): Promise<AxiosResponse<T, D, {}>>

  Type Parameters

  • T
  • D extends JsonLike
  • P extends JsonLike

  Parameters

  • endpoint: string
  • Optionaloptions: RequestOptions<D, P>

  Returns Promise<AxiosResponse<T, D, {}>>

delete

• delete<T, P extends JsonLike>(
      endpoint: string,
      options?: Omit<RequestOptions<never, P>, "data">,
  ): Promise<AxiosResponse<T, never, {}>>

  Type Parameters

  • T
  • P extends JsonLike

  Parameters

  • endpoint: string
  • Optionaloptions: Omit<RequestOptions<never, P>, "data">

  Returns Promise<AxiosResponse<T, never, {}>>

loadTracks

• loadTracks(identifier: string): Promise<LoadResult>

  Parameters

  • identifier: string

  Returns Promise<LoadResult>

decodeTrack

• decodeTrack(encodedTrack: string): Promise<APITrack<EmptyObject, EmptyObject>>

  Parameters

  • encodedTrack: string

  Returns Promise<APITrack<EmptyObject, EmptyObject>>

decodeTracks

• decodeTracks(tracks: string[]): Promise<APITrack<EmptyObject, EmptyObject>[]>

  Parameters

  • tracks: string[]

  Returns Promise<APITrack<EmptyObject, EmptyObject>[]>

fetchPlayers

• fetchPlayers(sessionId?: string): Promise<APIPlayer[]>

  Parameters

  • sessionId: string = ...

  Returns Promise<APIPlayer[]>

fetchPlayer

• fetchPlayer(guildId: string, sessionId?: string): Promise<APIPlayer>

  Parameters

  • guildId: string
  • sessionId: string = ...

  Returns Promise<APIPlayer>

updatePlayer

• updatePlayer(
      guildId: string,
      options: PlayerUpdateRequestBody,
      params?: PlayerUpdateQueryParams,
      sessionId?: string,
  ): Promise<APIPlayer>

  Parameters

  • guildId: string
  • options: PlayerUpdateRequestBody
  • Optionalparams: PlayerUpdateQueryParams
  • sessionId: string = ...

  Returns Promise<APIPlayer>

destroyPlayer

• destroyPlayer(guildId: string, sessionId?: string): Promise<boolean>

  Parameters

  • guildId: string
  • sessionId: string = ...

  Returns Promise<boolean>

updateSession

• updateSession(
      options: SessionUpdateRequestBody,
      sessionId?: string,
  ): Promise<Required<SessionUpdateRequestBody>>

  Parameters

  • options: SessionUpdateRequestBody
  • sessionId: string = ...

  Returns Promise<Required<SessionUpdateRequestBody>>

fetchInfo

• fetchInfo(): Promise<LavalinkInfo>

  Returns Promise<LavalinkInfo>

fetchStats

• fetchStats(): Promise<NodeStats>

  Returns Promise<NodeStats>

fetchRoutePlannerStatus

• fetchRoutePlannerStatus(): Promise<RoutePlannerStatus>

  Returns Promise<RoutePlannerStatus>

unmarkFailedAddress

• unmarkFailedAddress(address: string): Promise<boolean>

  Parameters

  • address: string

  Returns Promise<boolean>

unmarkAllFailedAddresses

• unmarkAllFailedAddresses(): Promise<boolean>

  Returns Promise<boolean>