Skip to content

QueueSaver

Defined in: src/structures/Queue.ts:7

new QueueSaver(options: ManagerQueueOptions): QueueSaver;

Defined in: src/structures/Queue.ts:18

ParameterType
optionsManagerQueueOptions

QueueSaver

Property (defined in)TypeDescription
options
(src/structures/Queue.ts:15)
objectThe options for the queue saver
options.maxPreviousTracks
(src/structures/Queue.ts:16)
number
delete(guildId: string): Promise<boolean | void>;

Defined in: src/structures/Queue.ts:39

Delete the queue for a guild

ParameterTypeDescription
guildIdstringThe guild ID

Promise<boolean | void>

The queue for the guild


get(guildId: string): Promise<Partial<StoredQueue>>;

Defined in: src/structures/Queue.ts:30

Get the queue for a guild

ParameterTypeDescription
guildIdstringThe guild ID

Promise<Partial<StoredQueue>>

The queue for the guild


set(guildId: string, valueToStringify: StoredQueue): Promise<boolean | void>;

Defined in: src/structures/Queue.ts:49

Set the queue for a guild

ParameterTypeDescription
guildIdstringThe guild ID
valueToStringifyStoredQueueThe queue to set

Promise<boolean | void>

The queue for the guild


sync(guildId: string): Promise<Partial<StoredQueue>>;

Defined in: src/structures/Queue.ts:58

Sync the queue for a guild

ParameterTypeDescription
guildIdstringThe guild ID

Promise<Partial<StoredQueue>>

The queue for the guild