Class REST

constructor

• new REST(options: RESTOptions): REST

  Parameters

  • options: RESTOptions

  Returns REST

Readonlyorigin

Readonlyversion

Readonlytimeout

ReadonlybaseUrl

sessionId

• get sessionId(): string | null

  Returns string | null

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

  Parameters

  • id: string | null

  Returns void

userAgent

• get userAgent(): string

  Returns string

request

• request<T>(endpoint: string, options?: RequestOptions): Promise<RestResponse<T>>

  Type Parameters

  • T

  Parameters

  • endpoint: string
  • Optionaloptions: RequestOptions

  Returns Promise<RestResponse<T>>

get

• get<T>(
      endpoint: string,
      options?: Omit<RequestOptions, "method" | "data">,
  ): Promise<RestResponse<T>>

  Type Parameters

  • T

  Parameters

  • endpoint: string
  • Optionaloptions: Omit<RequestOptions, "method" | "data">

  Returns Promise<RestResponse<T>>

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>>

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>>

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>>

loadTracks

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

  Parameters

  • identifier: string

  Returns Promise<LoadResult>

decodeTrack

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

  Parameters

  • encodedTrack: string

  Returns Promise<APITrack<CommonUserData, CommonPluginInfo>>

decodeTracks

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

  Parameters

  • tracks: string[]

  Returns Promise<APITrack<CommonUserData, CommonPluginInfo>[]>

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>