Skip to content

LavalinkNodeOptions

Defined in: src/structures/Types/Node.ts:15

Node Options for creating a lavalink node

Property (defined in)TypeDescription
authorization
(src/structures/Types/Node.ts:21)
stringThe Lavalink Password / Authorization-Key
closeOnError?
(src/structures/Types/Node.ts:37)
booleanClose on error
enablePingOnStatsCheck?
(src/structures/Types/Node.ts:41)
booleanRecommended, to check wether the client is still connected or not on the stats endpoint
heartBeatInterval?
(src/structures/Types/Node.ts:39)
30000Heartbeat interval , set to <= 0 to disable heartbeat system
host
(src/structures/Types/Node.ts:17)
stringThe Lavalink Server-Ip / Domain-URL
id?
(src/structures/Types/Node.ts:27)
stringAdd a Custom ID to the node, for later use
port
(src/structures/Types/Node.ts:19)
numberThe Lavalink Connection Port
regions?
(src/structures/Types/Node.ts:29)
string[]Voice Regions of this Node
requestSignalTimeoutMS?numbersignal for cancelling requests - default: AbortSignal.timeout(options.requestSignalTimeoutMS
retryAmount?
(src/structures/Types/Node.ts:31)
numberThe retryAmount for the node.
retryDelay?
(src/structures/Types/Node.ts:33)
numberThe retryDelay for the node.
secure?
(src/structures/Types/Node.ts:23)
booleanDoes the Server use ssl (https)
sessionId?
(src/structures/Types/Node.ts:25)
stringRESUME THE PLAYER? by providing a sessionid on the node-creation