Skip to content

LavalinkNodeOptions

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

Node Options for creating a lavalink node

Property (defined in)TypeDescription
authorization
(src/structures/Types/Node.ts:20)
stringThe Lavalink Password / Authorization-Key
closeOnError?
(src/structures/Types/Node.ts:36)
booleanClose on error
enablePingOnStatsCheck?
(src/structures/Types/Node.ts:40)
booleanRecommended, to check wether the client is still connected or not on the stats endpoint
heartBeatInterval?
(src/structures/Types/Node.ts:38)
numberHeartbeat interval , set to <= 0 to disable heartbeat system
host
(src/structures/Types/Node.ts:16)
stringThe Lavalink Server-Ip / Domain-URL
id?
(src/structures/Types/Node.ts:26)
stringAdd a Custom ID to the node, for later use
port
(src/structures/Types/Node.ts:18)
numberThe Lavalink Connection Port
regions?
(src/structures/Types/Node.ts:28)
string[]Voice Regions of this Node
requestSignalTimeoutMS?numbersignal for cancelling requests - default: AbortSignal.timeout(options.requestSignalTimeoutMS
retryAmount?
(src/structures/Types/Node.ts:30)
numberThe retryAmount for the node.
retryDelay?
(src/structures/Types/Node.ts:32)
numberThe retryDelay for the node.
secure?
(src/structures/Types/Node.ts:22)
booleanDoes the Server use ssl (https)
sessionId?
(src/structures/Types/Node.ts:24)
stringRESUME THE PLAYER? by providing a sessionid on the node-creation