Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RESTHandler

REST handler instance

Hierarchy

  • RESTHandler

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

calls

calls: number = 0

Totat of request calls since constructed

options

options: RESTOptions

The rest handler options

pool

pool: Pool

The rest handler connection pool

Accessors

router

url

  • get url(): string

Methods

decodeTrack

  • decodeTrack(track: string): Promise<Track>

  • Decode base64 encoded serialized track

    Parameters

    • track: string

    Returns Promise<Track>

decodeTracks

  • decodeTracks(tracks: string[]): Promise<Tracks>

  • Decode base64 encoded serialized tracks

    Parameters

    • tracks: string[]

    Returns Promise<Tracks>

loadTracks

plugins

  • plugins(): Promise<Plugins>

request

  • request(method: string, route: string, body?: unknown): Promise<ResponseData>

  • Do api request to the server

    Parameters

    • method: string
    • route: string
    • Optional body: unknown

    Returns Promise<ResponseData>

routeplannerStatus

  • routeplannerStatus(): Promise<RoutePlannerStatus>

  • Get the lavalink server routeplanner status

    Returns Promise<RoutePlannerStatus>

unmarkAddress

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

  • Unmark a failed address

    Parameters

    • address: string

    Returns Promise<boolean>

unmarkAllAddress

  • unmarkAllAddress(): Promise<boolean>

Generated using TypeDoc