QueueSaver
Constructors
new QueueSaver()
new QueueSaver(options: ManagerQueueOptions): QueueSaverParameters
| Parameter | Type |
|---|---|
options | ManagerQueueOptions |
Returns
Defined in
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
options | public | object | The options for the queue saver | src/structures/Queue.ts:16 |
options.maxPreviousTracks | public | number | - | src/structures/Queue.ts:17 |
Methods
delete()
delete(guildId: string): Promise<boolean | void>Delete the queue for a guild
Parameters
| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
Returns
Promise<boolean | void>
The queue for the guild
Defined in
get()
get(guildId: string): Promise<Partial<StoredQueue>>Get the queue for a guild
Parameters
| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
Returns
Promise<Partial<StoredQueue>>
The queue for the guild
Defined in
set()
set(guildId: string, valueToStringify: StoredQueue): Promise<boolean | void>Set the queue for a guild
Parameters
| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
valueToStringify | StoredQueue | The queue to set |
Returns
Promise<boolean | void>
The queue for the guild
Defined in
sync()
sync(guildId: string): Promise<Partial<StoredQueue>>Sync the queue for a guild
Parameters
| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
Returns
Promise<Partial<StoredQueue>>
The queue for the guild