mirrors/Equicord
1
1
Fork 0
mirror of https://github.com/Equicord/Equicord.git synced 2025-06-20 03:47:01 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

[skip ci] docs docs docs

Browse source
This commit is contained in:
Vendicated 2022-11-25 19:25:35 +01:00
parent c2c6c9fccb
commit a85ec594a7
No known key found for this signature in database
GPG key ID: EC781ADFB93EFFA3
7 changed files with 63 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

23
src/utils/Queue.ts
View file

@ -18,14 +18,18 @@
import { Promisable } from "type-fest";
/**
* A queue that can be used to run tasks consecutively.
* Highly recommended for things like fetching data from Discord
*/
export class Queue {
/**
* @param maxSize The maximum amount of functions that can be queued at once.
* If the queue is full, the oldest function will be removed.
* If the queue is full, the oldest function will be removed.
*/
constructor(public maxSize = Infinity) { }
queue = [] as Array<() => Promisable<unknown>>;
private queue = [] as Array<() => Promisable<unknown>>;
private promise?: Promise<any>;
@ -34,7 +38,7 @@ export class Queue {
if (func)
this.promise = Promise.resolve()
.then(func)
.then(() => this.next());
.finally(() => this.next());
else
this.promise = undefined;
}
@ -44,6 +48,11 @@ export class Queue {
this.next();
}
/**
* Append a task at the end of the queue. This task will be executed after all other tasks
* If the queue exceeds the specified maxSize, the first task in queue will be removed.
* @param func Task
*/
push<T>(func: () => Promisable<T>) {
if (this.size >= this.maxSize)
this.queue.shift();
@ -52,6 +61,11 @@ export class Queue {
this.run();
}
/**
* Prepend a task at the beginning of the queue. This task will be executed next
* If the queue exceeds the specified maxSize, the last task in queue will be removed.
* @param func Task
*/
unshift<T>(func: () => Promisable<T>) {
if (this.size >= this.maxSize)
this.queue.pop();
@ -60,6 +74,9 @@ export class Queue {
this.run();
}
/**
* The amount of tasks in the queue
*/
get size() {
return this.queue.length;
}