Class QueuePersistencePlugin

Queue Persistence Plugin - Saves and restores queue state Useful for bot restarts or crashes

Hierarchy (view full)

PlayerPlugin<QueuePersistencePluginEvents & Record<string, unknown[]>>
- QueuePersistencePlugin

Index

Constructors

Properties

Methods

init saveQueue loadQueue deleteQueue getAllQueues

Constructors

constructor

new QueuePersistencePlugin(store?, autoSave?): QueuePersistencePlugin
Parameters
- Optional store: QueueStore
- autoSave: boolean = true
Returns QueuePersistencePlugin
Overrides PlayerPlugin.constructor
- Defined in extensions/PersistenceExtension.ts:79

Properties

`Protected` _

_: QueuePersistencePluginEvents & Record<string, unknown[]>

Type helper for event map - not used at runtime

`Readonly` name

name: "queue-persistence" = ...

Unique name for the plugin - must be readonly Used to identify and access the plugin from player.plugins

Methods

init

init(player): void
Initialize the plugin with the player instance Called once when the player is initialized
Parameters
- player: Player<QueueContext, []>
  The player instance to attach to
Returns void
Overrides PlayerPlugin.init
- Defined in extensions/PersistenceExtension.ts:85

saveQueue

saveQueue(guildId): Promise<void>
Save queue state
Parameters
- guildId: string
Returns Promise<void>
- Defined in extensions/PersistenceExtension.ts:108

loadQueue

loadQueue(guildId): Promise<null | StoredQueue>
Load queue state
Parameters
- guildId: string
Returns Promise<null | StoredQueue>
- Defined in extensions/PersistenceExtension.ts:149

deleteQueue

deleteQueue(guildId): Promise<void>
Delete saved queue
Parameters
- guildId: string
Returns Promise<void>
- Defined in extensions/PersistenceExtension.ts:171

getAllQueues

getAllQueues(): Promise<StoredQueue[]>
Get all saved queues

Returns Promise<StoredQueue[]>
- Defined in extensions/PersistenceExtension.ts:178