Skip to content

LavalinkNodeOptions

Node Options for creating a lavalink node

Properties

PropertyTypeDescriptionDefined in
authorizationstringThe Lavalink Password / Authorization-Keysrc/structures/Types/Node.ts:21
closeOnError?booleanClose on errorsrc/structures/Types/Node.ts:37
enablePingOnStatsCheck?booleanRecommended, to check wether the client is still connected or not on the stats endpointsrc/structures/Types/Node.ts:41
heartBeatInterval?30000Heartbeat interval , set to <= 0 to disable heartbeat systemsrc/structures/Types/Node.ts:39
hoststringThe Lavalink Server-Ip / Domain-URLsrc/structures/Types/Node.ts:17
id?stringAdd a Custom ID to the node, for later usesrc/structures/Types/Node.ts:27
portnumberThe Lavalink Connection Portsrc/structures/Types/Node.ts:19
regions?string[]Voice Regions of this Nodesrc/structures/Types/Node.ts:29
requestSignalTimeoutMS?numbersignal for cancelling requests - default: AbortSignal.timeout(options.requestSignalTimeoutMS
retryAmount?numberThe retryAmount for the node.src/structures/Types/Node.ts:31
retryDelay?numberThe retryDelay for the node.src/structures/Types/Node.ts:33
secure?booleanDoes the Server use ssl (https)src/structures/Types/Node.ts:23
sessionId?stringRESUME THE PLAYER? by providing a sessionid on the node-creationsrc/structures/Types/Node.ts:25