LavalinkNodeOptions
Defined in: src/structures/Types/Node.ts:15
Node Options for creating a lavalink node
Properties
Section titled “Properties”Property (defined in) | Type | Description |
---|---|---|
authorization (src/structures/Types/Node.ts:21) | string | The Lavalink Password / Authorization-Key |
closeOnError? (src/structures/Types/Node.ts:37) | boolean | Close on error |
enablePingOnStatsCheck? (src/structures/Types/Node.ts:41) | boolean | Recommended, to check wether the client is still connected or not on the stats endpoint |
heartBeatInterval? (src/structures/Types/Node.ts:39) | 30000 | Heartbeat interval , set to <= 0 to disable heartbeat system |
host (src/structures/Types/Node.ts:17) | string | The Lavalink Server-Ip / Domain-URL |
id? (src/structures/Types/Node.ts:27) | string | Add a Custom ID to the node, for later use |
port (src/structures/Types/Node.ts:19) | number | The Lavalink Connection Port |
regions? (src/structures/Types/Node.ts:29) | string [] | Voice Regions of this Node |
requestSignalTimeoutMS? | number | signal for cancelling requests - default: AbortSignal.timeout(options.requestSignalTimeoutMS |
retryAmount? (src/structures/Types/Node.ts:31) | number | The retryAmount for the node. |
retryDelay? (src/structures/Types/Node.ts:33) | number | The retryDelay for the node. |
secure? (src/structures/Types/Node.ts:23) | boolean | Does the Server use ssl (https) |
sessionId? (src/structures/Types/Node.ts:25) | string | RESUME THE PLAYER? by providing a sessionid on the node-creation |