🌋
Vulkava
  • Introduction
  • Getting started
  • Custom Queue
  • Filters example
  • Common issues
  • 📚Docs
    • 🌋Vulkava
    • 🎵Player
    • 🎙️Recorder
    • 📑DefaultQueue
    • 🎛️Filters
    • 🪢Node
    • 💿Track
    • 💿UnresolvedTrack
  • 🖌️Abstract Classes
    • 📶AbstractExternalSource
    • 🎹AbstractQueue
  • 🔖Typedefs
    • 🔍SearchResult
    • 🌋VulkavaOptions
    • 🎛️FilterOptions
    • 🪢NodeOptions
    • 📡NodeStats
    • 🔎SEARCH_SOURCE
  • 📑Enums
    • ConnectionState
    • NodeState
Powered by GitBook
On this page
  1. Typedefs

NodeOptions

Lavalink node options

PreviousFilterOptionsNextNodeStats

Last updated 2 years ago

Property
Description
Type

id

The node identifier

hostname

The node hostname

port

The node port

password

The node password

(optional)

secure

Whether to use SSL or not

(optional)

sendSpeakingEvents

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

(optional)

followRedirects

Whether to follow redirects or not (for ws)

(optional)

region

The node region

"EU" | "USA" (optional)

resumeKey

The resume key (enables lavalink resume system if provided)

(optional)

resumeTimeout

The resume timeout (destroy all players after node disconnection)

(optional)

maxRetryAttempts

Max websocket reconnection attempts (default is 10)

(optional)

retryAttemptsInterval

Interval between reconnect attempts in milliseconds (default is 5000)

(optional)

transport

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

'websocket' | 'rest' (optional)

🔖
🪢
String
String
Number
String
Boolean
Boolean
Boolean
String
Number
Number
Number