ShoukakuOptions

Properties

alwaysSendResumeKey?

optional alwaysSendResumeKey: boolean

Disables the first time initialization tracking of nodes, and just sends the resume key always (Note: Useful for people who save their players to redis and wants to resume sessions even at first boot)

Defined in

src/Shoukaku.ts:63

---

moveOnDisconnect?

optional moveOnDisconnect: boolean

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

Defined in

src/Shoukaku.ts:79

---

reconnectInterval?

optional reconnectInterval: number

Timeout before trying to reconnect

Defined in

src/Shoukaku.ts:71

---

reconnectTries?

optional reconnectTries: number

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

Defined in

src/Shoukaku.ts:67

---

restTimeout?

optional restTimeout: number

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

Defined in

src/Shoukaku.ts:75

---

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:47

---

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:59

---

resumeKey?

optional resumeKey: string

Resume key for Lavalink

Defined in

src/Shoukaku.ts:51

---

resumeTimeout?

optional resumeTimeout: number

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

Defined in

src/Shoukaku.ts:55

---

structures?

optional structures: Structures

Custom structures for shoukaku to use

Defined in

src/Shoukaku.ts:87

---

userAgent?

optional userAgent: string

User Agent to use when making requests to Lavalink

Defined in

src/Shoukaku.ts:83