Skip to main content
Version: v2.10.0

Interface: NodeOptions

Represents the configuration object for connecting to a Lavalink or Nodelink node.
These options control connection, retries, resume behavior, and priority.

Property Type Description Optional
hoststringThe hostname or IP address of the Lavalink node.
portnumberPort used to connect to the node.
passwordstringPassword required to authenticate with the node.
useSSLbooleanIf true, connects over HTTPS/WSS.
identifierstringA unique identifier for this node. Helpful for logging or cluster setups.
maxRetryAttemptsnumberNumber of reconnection attempts before giving up.
retryDelayMsnumberMilliseconds between reconnection attempts.
enableSessionResumeOptionbooleanWhether the node should resume existing players on reconnect.
sessionTimeoutSecondsnumberTime (in seconds) the server should wait before removing a disconnected session.
apiRequestTimeoutMsnumberRequest timeout for REST API calls to the node.
nodePrioritynumberDetermines the priority of the node when selecting nodes dynamically. Higher = more preferred.
isNodeLinkbooleanWhether the node is a NodeLink node.
isBackupbooleanWhether the node is a backup node.