Node | @discord-rose/lavalink

Hierarchy

EventEmitter<NodeEvents>
- Node

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Node(options: NodeOptions, identifier: number, manager: LavalinkManager): Node

Overrides EventEmitter<NodeEvents>.constructor
- Defined in structures/Node.ts:192
Create a node.

Parameters
- options: NodeOptions
  
  The options to use for the node.
- identifier: number
  
  The node's identifier.
- manager: LavalinkManager
  
  The node's manager.
Returns Node

Properties

identifier

identifier: number

manager

manager: LavalinkManager

Readonly options

options: CompleteNodeOptions

The node's options.

state

state: NodeState = ...

The node's state.

stats

stats: NodeStats = ...

The node's stats.

Methods

connect

connect(): Promise<void>

- Defined in structures/Node.ts:230
Connect the node to the lavalink server.

Returns Promise<void>

destroy

destroy(reason?: string): void

- Defined in structures/Node.ts:283
Destroy the node and all attatched players.

Parameters
- reason: string = 'Manual destroy'
  
  The reason the node was destroyed.
Returns void

request

request(method: RequestMethods, route: string, options?: RequestOptions): Promise<{ json: any; res: Response }>

- Defined in structures/Node.ts:326
Make a REST request.

Parameters
- method: RequestMethods
  
  The method to use.
- route: string
  
  The route to use.
- options: RequestOptions = {}
  
  Request options.
Returns Promise<{ json: any; res: Response }>

The response from the server.

send

send(msg: any): Promise<boolean>

- Defined in structures/Node.ts:307
Send data to the lavalink server.

Parameters
- msg: any
  
  The data to send.
Returns Promise<boolean>

Generated using TypeDoc