RedisQueue

Table of Contents

• Class Definition
• Properties
• Constructor
• Methods

Class Definition

export class RedisQueue implements IQueue {}

Properties

Property	Type	Description
redis	RedisClient	The Redis client.
redisPrefix	string	The Redis prefix.

Constructor

new MemoryQueue(guildId: string, manager: Manager)

Parameter	Type	Description	Optional
guildId	string	The guild ID
manager	Manager	The Manager instance.

Methods

add()

async add(track: Track | Track[], offset?: number): Promise<void>

Adds a track or an array of tracks to the queue.

Parameters

Parameter	Type	Description	Optional
track	Track | Track[]	The track or an array of tracks to add to the queue.
offset	number	The offset to add the track at.

---

addPrevious()

async addPrevious(track: Track | Track[]): Promise<void>

Adds one or more tracks to the "previous" history list.

Parameters

Parameter	Type	Description	Optional
track	Track | Track[]	The track to add to the "previous" history list.

---

clear()

async clear(): Promise<void>

Clears the queue.

---

clearPrevious()

async clearPrevious(): Promise<void>

Clears the "previous" history list.

---

dequeue()

async dequeue(): Promise<Track | undefined>

Removes the first element from the queue.

Returns

Type	Description
Track | undefined	The first element in the queue, or undefined if the queue is empty.

---

destroy()

async destroy(): Promise<void>

Destroys the queue and releases all resources. After calling this method, the queue must not be used again.

---

duration()

async duration(): Promise<number>

Returns the total duration of the queue.

Returns

Type	Description
number	The total duration of the queue in milliseconds.

---

enqueueFront()

async enqueueFront(track: Track | Track[]): Promise<void>

Adds a track or an array of tracks to the front of the queue.

Parameters

Parameter	Type	Description	Optional
track	Track | Track[]	The track or an array of tracks to add to the queue.

---

everyAsync()

async everyAsync(callback: (track: Track, index: number, array: Track[]) => boolean): Promise<boolean>

Tests whether all elements in the queue pass the test implemented by the provided function.

Parameters

Parameter	Type	Description	Optional
callback	Function	The callback function.

Returns

Type	Description
boolean	true if the callback function returns a truthy value for every element in the queue, otherwise false.

---

filterAsync()

async filterAsync(callback: (track: Track, index: number, array: Track[]) => boolean): Promise<Track | undefined>

Filters the queue.

Parameters

Parameter	Type	Description	Optional
callback	Function	The callback function.

Returns

Type	Description
Track | undefined	The first element in the queue, or undefined if the queue is empty.

---

findAsync()

async findAsync(callback: (track: Track, index: number, array: Track[]) => boolean): Promise<Track | undefined>

Returns the first element in the queue that satisfies the provided testing function.

Parameters

Parameter	Type	Description	Optional
callback	Function	The callback function.

Returns

Type	Description
Track | undefined	The first element in the queue, or undefined if the queue is empty.

---

getCurrent()

async getCurrent(): Promise<Track | null>

Returns the currently playing track.

Returns

Type	Description
Track | null	The current track, or null if no track is playing.

---

getPrevious()

async getPrevious(): Promise<Track[]>

Returns the previous tracks.

Returns

Type	Description
Track[]	The previous tracks.

---

getSlice()

async getSlice(start?: number, end?: number): Promise<Track[]>

Returns a slice of the queue.

Parameters

Parameter	Type	Description	Optional
start	number	Start index of the range of tracks to remove.
end	number	End index (exclusive) of the range of tracks to remove.

Returns

Type	Description
Track[]	The tracks in the queue.

---

getTracks()

async getTracks(): Promise<Track[]>

Returns the tracks in the queue.

Returns

Type	Description
Track[]	The tracks in the queue.

---

mapAsync()

async mapAsync<T>(callback: (track: Track, index: number, array: Track[]) => T): Promise<T[]>

Maps the queue to an array of values.

Parameters

Parameter	Type	Description	Optional
callback	Function	The callback function.

---

modifyAt()

async modifyAt(start: number, deleteCount = 0, ...items: Track[]): Promise<Track[]>

Modifies a range of tracks in the queue.

Parameters

Parameter	Type	Description	Optional
start	number	Start index of the range of tracks to remove.
deleteCount	number	Number of tracks to remove.
items	Track[]	Array of tracks to insert.

Returns

Type	Description
Track[]	The tracks in the queue.

---

popPrevious()

async popPrevious(): Promise<Track | null>

Removes and returns the last track from the "previous" history list.

Returns

Type	Description
Track | null	The last track in the "previous" history list, or null if the list is empty.

---

remove()

async remove(position?: number): Promise<Track[]>
async remove(start: number, end: number): Promise<Track[]>

Removes a track or a range of tracks from the queue.

Parameters

Parameter	Type	Description	Optional
position	number	Index of the track to remove.
start	number	Start index of the range of tracks to remove.
end	number	End index (exclusive) of the range of tracks to remove.

Returns

Type	Description
Track[]	The removed track(s).

---

roundRobinShuffle()

async roundRobinShuffle(): Promise<void>

Shuffles the queue to play tracks requested by each user one by one.

---

setCurrent()

async setCurrent(track: Track | null): Promise<void>

Sets the currently playing track.

Parameters

Parameter	Type	Description	Optional
track	Track | null	The track to set as the current track.

---

setPrevious()

async setPrevious(tracks: Track[]): Promise<void>

Sets the previous tracks.

Parameters

Parameter	Type	Description	Optional
tracks	Track[]	The previous tracks to set.

---

shuffle()

async shuffle(): Promise<void>

Shuffles the queue.

---

size()

async size(): Promise<number>

Returns the size of the queue not including the current track.

Returns

Type	Description
number	The size of the queue.

---

someAsync()

async someAsync(callback: (track: Track, index: number, array: Track[]) => boolean): Promise<boolean>

Tests whether at least one element in the queue passes the test implemented by the provided function.

Parameters

Parameter	Type	Description	Optional
callback	Function	The callback function.

Returns

Type	Description
boolean	true if the callback function returns a truthy value for at least one element in the queue, otherwise false.

---

totalSize()

async totalSize(): Promise<number>

Returns the total size of the queue.

Returns

Type	Description
number	The total size of the queue.

---

userBlockShuffle()

async userBlockShuffle(): Promise<void>

Shuffles the queue to play tracks requested by each user one block at a time.