ShoukakuOptions

Properties

moveOnDisconnect?

optional moveOnDisconnect: boolean

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

Defined in

src/Shoukaku.ts:72

---

nodeResolver()?

optional nodeResolver: (nodes, connection?) => undefined | Node

Node Resolver to use if you want to customize it

Parameters

• nodes: Map<string, Node>

• connection?: Connection

Returns

undefined | Node

Defined in

src/Shoukaku.ts:88

---

reconnectInterval?

optional reconnectInterval: number

Timeout before trying to reconnect

Defined in

src/Shoukaku.ts:64

---

reconnectTries?

optional reconnectTries: number

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

Defined in

src/Shoukaku.ts:60

---

restTimeout?

optional restTimeout: number

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

Defined in

src/Shoukaku.ts:68

---

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

src/Shoukaku.ts:48

---

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

src/Shoukaku.ts:56

---

resumeTimeout?

optional resumeTimeout: number

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

Defined in

src/Shoukaku.ts:52

---

structures?

optional structures: Structures

Custom structures for shoukaku to use

Defined in

src/Shoukaku.ts:80

---

userAgent?

optional userAgent: string

User Agent to use when making requests to Lavalink

Defined in

src/Shoukaku.ts:76

---

voiceConnectionTimeout?

optional voiceConnectionTimeout: number

Timeout before abort connection

Defined in

src/Shoukaku.ts:84