Class RestClient<TMiddleware>

Exendable generic REST client to make requests to Lavalink

Type Parameters

TMiddleware extends RestMiddleware = NoopMiddleware

Index

Constructors

Properties

auth baseUrl middleware nodePlugins restTimeout userAgent

Methods

_getNodePlugins fetch

Constructors

constructor

new RestClient<TMiddleware extends RestMiddleware = NoopMiddleware>(
    auth: string,
    userAgent: string,
    baseUrl: string,
    restTimeout: number,
    nodePlugins?: NodeInfoPlugin[] | null,
    middleware?: TMiddleware,
): RestClient<TMiddleware>
Type Parameters
- TMiddleware extends RestMiddleware = NoopMiddleware
Parameters
- auth: string
  Credentials to access Lavalnk
- userAgent: string
  User Agent to use when making requests to Lavalink
- baseUrl: string
  URL of Lavalink
- restTimeout: number
  Time to wait for a response from the Lavalink REST API before giving up
- nodePlugins: NodeInfoPlugin[] | null = null
  Plugins available on this node
- middleware: TMiddleware = ...
  Inject headers and params globally, see RestMiddleware
Returns RestClient<TMiddleware>
- Defined in src/node/Rest.ts:411

Properties

`Protected` `Readonly`auth

auth: string

Credentials to access Lavalnk

`Protected` `Readonly`baseUrl

baseUrl: string

URL of Lavalink

`Protected` `Readonly`middleware

middleware: TMiddleware = ...

Inject headers and params globally, see RestMiddleware

`Protected`nodePlugins

nodePlugins: NodeInfoPlugin[] | null = null

Plugins available on this node

`Protected` `Readonly`restTimeout

restTimeout: number

Time to wait for a response from the Lavalink REST API before giving up

`Protected` `Readonly`userAgent

userAgent: string

User Agent to use when making requests to Lavalink

Methods

_getNodePlugins

_getNodePlugins(): Promise<NodeInfoPlugin[]>
Internal
Get a list of plugins available on this node, you should use Rest#getLavalinkInfo instead

Returns Promise<NodeInfoPlugin[]>
A list of plugins
- Defined in src/node/Rest.ts:426

fetch

fetch<TEndpoint extends RestEndpoint, TResponse = TReturnType<TEndpoint>>(
endpoint: TEndpoint,
): Promise<TResponse | undefined>
Fetch data from endpoint based on config RestEndpoint and middleware
Type Parameters
- TEndpoint extends RestEndpoint
- TResponse = TReturnType<TEndpoint>
Parameters
- endpoint: TEndpoint
  Endpoint config (see RestEndpoint)
Returns Promise<TResponse | undefined>
Response as specified by endpoint's TResponse function

Throws
RestError from Lavalink error response

Throws
DeserializationError when parsing response as JSON fails

Throws
PluginError when plugin required by endpoint is not satisfied by plugins on this node
- Defined in src/node/Rest.ts:444