LavalinkNodeOptions
Defined in: src/structures/Types/Node.ts:26
Node Options for creating a lavalink node
Properties
Section titled “Properties”| Property (defined in) | Type | Description |
|---|---|---|
authorization (src/structures/Types/Node.ts:36) | string | The Lavalink Password / Authorization-Key |
autoChecks? (src/structures/Types/Node.ts:67) | object | Per Node Options |
autoChecks.pluginValidations? (src/structures/Types/Node.ts:69) | boolean | Wether to check for every node to check for plugin validations or not. (ignored for NodeType NodeLink) |
autoChecks.sourcesValidations? (src/structures/Types/Node.ts:71) | boolean | Wether to check for every node to check for source validations or not. |
closeOnError? (src/structures/Types/Node.ts:61) | boolean | Close on error |
enablePingOnStatsCheck? (src/structures/Types/Node.ts:65) | boolean | Recommended, to check whether the client is still connected or not on the stats endpoint |
heartBeatInterval? (src/structures/Types/Node.ts:63) | number | Heartbeat interval , set to <= 0 to disable heartbeat system |
host (src/structures/Types/Node.ts:32) | string | The Lavalink Server-Ip / Domain-URL |
id? (src/structures/Types/Node.ts:49) | string | Add a Custom ID to the node, for later use |
nodeType? (src/structures/Types/Node.ts:28) | NodeTypes | Specify the Node-Type of this node. Default: Lavalink |
port (src/structures/Types/Node.ts:34) | number | The Lavalink Connection Port |
priority? (src/structures/Types/Node.ts:38) | number | Optional priority helper for custom node selection strategies. |
regions? (src/structures/Types/Node.ts:51) | string[] | Voice Regions of this Node |
requestSignalTimeoutMS? | number | signal for cancelling requests - default: AbortSignal.timeout(options.requestSignalTimeoutMS |
retryAmount? (src/structures/Types/Node.ts:53) | number | The max amount of retries for this node. |
retryDelay? (src/structures/Types/Node.ts:55) | number | The delay of how often to retry a reconnection. |
retryTimespan? (src/structures/Types/Node.ts:57) | number | How long a retry is a valid retry, it should be at least retryAmount*retryDelay. if <= 0 (default) then this won’t be accounted. |
secure? (src/structures/Types/Node.ts:45) | boolean | Does the Server use ssl (https) |
sessionId? (src/structures/Types/Node.ts:47) | string | RESUME THE PLAYER? by providing a sessionid on the node-creation |
version? (Lavalink API version path (e.g. v3 or v4). Defaults to v4.) | "v3" \ | "v4" |
wsPath? (src/structures/Types/Node.ts:43) | string | Optional websocket path override (must start with ”/”). Defaults to /${version}/websocket. |