Skip to content

ShoukakuOptions

Properties

moveOnDisconnect?

optional moveOnDisconnect: boolean;

Whether to move players to a different Lavalink node when a node disconnects

Defined in

shoukaku/src/Shoukaku.ts:76


nodeResolver()?

optional nodeResolver: (nodes: Map<string, Node>, connection?: Connection) => undefined | Node;

Node Resolver to use if you want to customize it

Parameters

ParameterType
nodesMap<string, Node>
connection?Connection

Returns

undefined | Node

Defined in

shoukaku/src/Shoukaku.ts:92


reconnectInterval?

optional reconnectInterval: number;

Timeout before trying to reconnect

Defined in

shoukaku/src/Shoukaku.ts:68


reconnectTries?

optional reconnectTries: number;

Number of times to try and reconnect to Lavalink before giving up

Defined in

shoukaku/src/Shoukaku.ts:64


restTimeout?

optional restTimeout: number;

Time to wait for a response from the Lavalink REST API before giving up

Defined in

shoukaku/src/Shoukaku.ts:72


resume?

optional resume: boolean;

Whether to resume a connection on disconnect to Lavalink (Server Side) (Note: DOES NOT RESUME WHEN THE LAVALINK SERVER DIES)

Defined in

shoukaku/src/Shoukaku.ts:52


resumeByLibrary?

optional resumeByLibrary: boolean;

Whether to resume the players by doing it in the library side (Client Side) (Note: TRIES TO RESUME REGARDLESS OF WHAT HAPPENED ON A LAVALINK SERVER)

Defined in

shoukaku/src/Shoukaku.ts:60


resumeTimeout?

optional resumeTimeout: number;

Time to wait before lavalink starts to destroy the players of the disconnected client

Defined in

shoukaku/src/Shoukaku.ts:56


structures?

optional structures: Structures;

Custom structures for shoukaku to use

Defined in

shoukaku/src/Shoukaku.ts:84


userAgent?

optional userAgent: string;

User Agent to use when making requests to Lavalink

Defined in

shoukaku/src/Shoukaku.ts:80


voiceConnectionTimeout?

optional voiceConnectionTimeout: number;

Timeout before abort connection

Defined in

shoukaku/src/Shoukaku.ts:88