QueueSaver
Defined in: src/structures/Queue.ts:4
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new QueueSaver(options: ManagerQueueOptions): QueueSaver;Defined in: src/structures/Queue.ts:15
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | ManagerQueueOptions |
Returns
Section titled “Returns”QueueSaver
Properties
Section titled “Properties”| Property (defined in) | Type | Description |
|---|---|---|
options (src/structures/Queue.ts:12) | object | The options for the queue saver |
options.maxPreviousTracks (src/structures/Queue.ts:13) | number |
Methods
Section titled “Methods”delete()
Section titled “delete()”delete(guildId: string): Promise<boolean | void>;Defined in: src/structures/Queue.ts:36
Delete the queue for a guild
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
Returns
Section titled “Returns”Promise<boolean | void>
The queue for the guild
get(guildId: string): Promise<Partial<StoredQueue>>;Defined in: src/structures/Queue.ts:27
Get the queue for a guild
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
Returns
Section titled “Returns”Promise<Partial<StoredQueue>>
The queue for the guild
set(guildId: string, valueToStringify: StoredQueue): Promise<boolean | void>;Defined in: src/structures/Queue.ts:46
Set the queue for a guild
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
valueToStringify | StoredQueue | The queue to set |
Returns
Section titled “Returns”Promise<boolean | void>
The queue for the guild
sync()
Section titled “sync()”sync(guildId: string): Promise<Partial<StoredQueue>>;Defined in: src/structures/Queue.ts:55
Sync the queue for a guild
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
guildId | string | The guild ID |
Returns
Section titled “Returns”Promise<Partial<StoredQueue>>
The queue for the guild