🪢NodeOptions

Lavalink node options

PropertyDescriptionType

id

The node identifier

hostname

The node hostname

port

The node port

password

The node password

String (optional)

secure

Whether to use SSL or not

Boolean (optional)

sendSpeakingEvents

Tells to the lavalink server to send speaking events eg. speaking start, speaking stop (default is false)

Boolean (optional)

followRedirects

Whether to follow redirects or not (for ws)

Boolean (optional)

region

The node region

"EU" | "USA" (optional)

resumeKey

The resume key (enables lavalink resume system if provided)

String (optional)

resumeTimeout

The resume timeout (destroy all players after node disconnection)

Number (optional)

maxRetryAttempts

Max websocket reconnection attempts (default is 10)

Number (optional)

retryAttemptsInterval

Interval between reconnect attempts in milliseconds (default is 5000)

Number (optional)

transport

Whether to send messages to lavalink through websocket or REST. (REST available in lavalink >= v3.7) (default is websocket).

'websocket' | 'rest' (optional)

Last updated