Extras

ruvyrias

---

ruvyrias / Extras

Interface: Extras

Defined in: types/Node.ts:90

Represents an combo of additional options to node, directly brought from RuvyriasOptions

Extends

• RuvyriasOptions

Properties

autoResume?

optional autoResume: boolean

Defined in: types/Ruvyrias.ts:103

Whether to automatically resume playback after a player disconnect.

Inherited from

RuvyriasOptions.autoResume

---

clientId?

optional clientId: null | string

Defined in: types/Ruvyrias.ts:117

The client ID associated with the Ruvyrias instance.

Inherited from

RuvyriasOptions.clientId

---

currentAttempt

currentAttempt: number

Defined in: types/Node.ts:92

---

defaultPlatform?

optional defaultPlatform: PlatformsType

Defined in: types/Ruvyrias.ts:109

The default platform for resolving tracks if not specified.

Inherited from

RuvyriasOptions.defaultPlatform

---

isInitialized?

optional isInitialized: boolean

Defined in: types/Ruvyrias.ts:119

Indicates whether the Ruvyrias instance is activated or not.

Inherited from

RuvyriasOptions.isInitialized

---

library

library: LibrariesType

Defined in: types/Ruvyrias.ts:107

The library used for communication (e.g., 'discord.js', 'eris', etc.).

Inherited from

RuvyriasOptions.library

---

plugins?

optional plugins: Plugin[]

Defined in: types/Ruvyrias.ts:101

An array of plugins to be used with Ruvyrias.

Inherited from

RuvyriasOptions.plugins

---

resume?

optional resume: boolean

Defined in: types/Ruvyrias.ts:105

Whether to automatically resume playback after a node disconnect.

Inherited from

RuvyriasOptions.resume

---

resumeTimeout?

optional resumeTimeout: number

Defined in: types/Ruvyrias.ts:111

Timeout duration in milliseconds for automatic resuming of playback.

Inherited from

RuvyriasOptions.resumeTimeout

---

retryAmount?

optional retryAmount: null | number

Defined in: types/Ruvyrias.ts:115

Number of reconnection attempts allowed before giving up.

Inherited from

RuvyriasOptions.retryAmount

---

retryAttempt

retryAttempt: null | Timeout

Defined in: types/Node.ts:91

---

retryDelay?

optional retryDelay: null | number

Defined in: types/Ruvyrias.ts:113

Timeout duration in milliseconds for attempting reconnection to nodes.

Inherited from

RuvyriasOptions.retryDelay

---

sendPayload?

optional sendPayload: null | Function

Defined in: types/Ruvyrias.ts:121

A function used for sending packets to the communication library.

Inherited from

RuvyriasOptions.sendPayload