https://github.com/lavalibs/lavaqueue
A queue system for Lavalink, backed by Redis.
https://github.com/lavalibs/lavaqueue
discord lavalink playlist redis-queue typescript
Last synced: about 2 months ago
JSON representation
A queue system for Lavalink, backed by Redis.
- Host: GitHub
- URL: https://github.com/lavalibs/lavaqueue
- Owner: lavalibs
- License: mit
- Created: 2018-03-09T01:12:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-29T14:52:46.000Z (3 months ago)
- Last Synced: 2025-05-08T21:14:43.872Z (about 2 months ago)
- Topics: discord, lavalink, playlist, redis-queue, typescript
- Language: TypeScript
- Size: 308 KB
- Stars: 27
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lavaqueue
[](https://discord.gg/jXSKeW5)
A simple queue system for Lavalink, backed by Redis. Built as extension of [my generic Lavalink wrapper](https://github.com/appellation/lavalink.js).
## How to use
```js
const { Client: Lavaqueue } = require('lavaqueue');
const voice = new Lavaqueue({
userID: '', // the user that will be sending audio
password: '', // your lavalink password
hosts: {
rest: '', // your lavalink rest endpoint (include port and protocol)
ws: '', // your lavalink ws endpoint (include port and protocol)
redis: '', // your redis instance
},
send(guildID, packet) {
// send the packet to the appropriate gateway connection
},
advanceBy(queue, { previous, remaining }) { // optional
// called at the end of a track when the queue is otherwise unaware of how many tracks to
// advance by; returns a number: 0 to repeat, negative to advance in reverse, positive to
// advance forward
},
});
async function connect() {
const res = await voice.load('some identifier');
const queue = voice.queues.get('some guild ID');
await queue.player.join('channel id'); // join the voice channel
await queue.add(...res.tracks.map(t => t.track)); // add songs to the queue
await queue.start(); // start the queue
}
async function skip() {
await voice.queues.get('some guild ID').next();
}
async function stop() {
await voice.queues.get('some guild ID').stop();
}
```
Queues are resilient to crashes, meaning it's safe to blindly restart a queue: it will attempt to recover the previous song at the point the crash occurred. You can restart all currently playing queues by calling `voice.queues.start()`, although it is recommended to do so as infrequently as possible.
## Reference
### `Queue`
- `store: QueueStore`
- `guildID: string`
- *readonly* `player` - the [lavalink](https://github.com/lavalibs/lavalink.js) player
- `start(): Promise` - start the queue
- `add(...tracks: string[]): Promise` - add tracks to the queue
- `unshift(...tracks: string[]): Promise` - add tracks to the front of the queue
- `remove(track: string): PromiseLike` - remove a track from the queue
- `next(count: number = 1): Promise` - skip to the next song; pass negatives to advance in reverse, or 0 to repeat
- `sort(predicate?: (a: string, b: string) => number): Promise` - sort the upcoming tracks; resolves with the length of the queue
- `move(from: number, to: number): Promise` - move a track by index; resolves with the new list
- `shuffle(): Promise` - shuffle the list; resolves with the new list
- `splice(start: number, deleteCount?: number, ...tracks: string[]): Promise` - splice the list at the given position; works like [Array#splice](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice)
- `trim(start: number, end: number): PromiseLike` - trim the queue to between the specified positions
- `stop(): Promise` - stop playback
- `clear(): PromiseLike` - clear the queue
- `current(): Promise` - retrieve the current song: returns an object with properties `track` and `position`
- `tracks(start: number = 0, end: number = -1): Promise` - retrieves queued tracks
```ts
interface NP {
position: number;
track: string;
}
```
### `QueueStore extends Map`
- `client: Client`
- `redis: Redis` - the ioredis instance this queue store is using
- `start(filter?: (guildID: string) => boolean)` - start all currently playing queues, with an optional filter callback
- `get(key: string): Queue` - gets the specified queue, or creates one if none is found