Lavalink

Lavalink

Represents a Lavalink node

Constructor

Source:
Properties:
Name Type Description
host string The hostname for the node
port number The port number for the node
address string The full ws address for the node
region string The region for this node
userId string The client user id
numShards number The total number of shards the bot is running
password string The password used to connect
connected boolean If it's connected to the node
draining boolean True if this node will no longer take new connections
stats object The Lavalink node stats
Lavalink constructor
Parameters:
Name Type Description
options Object Lavalink node options
Properties
Name Type Attributes Default Description
host string The hostname to connect to
port string The port to connect with
region string The region of the node
numShards number The number of shards the bot is running
userId string The user id of the bot
password string The password for the Lavalink node
timeout number <optional>
 5000 Optional timeout in ms used for the reconnect backoff

Extends

  • EventEmitter

Methods

destroy()

Source:
Destroy the websocket connection

send(op, data)

Source:
Send data to Lavalink
Parameters:
Name Type Description
op string Op name
data * Data to send