Vencord/src/utils/Queue.ts

84 lines
2.5 KiB
TypeScript
Raw Normal View History

2022-10-21 22:41:33 -04:00
/*
* Vencord, a modification for Discord's desktop app
* Copyright (c) 2022 Vendicated and contributors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import { Promisable } from "type-fest";
2022-11-25 13:25:35 -05:00
/**
* A queue that can be used to run tasks consecutively.
* Highly recommended for things like fetching data from Discord
*/
2022-10-21 22:41:33 -04:00
export class Queue {
/**
* @param maxSize The maximum amount of functions that can be queued at once.
2022-11-25 13:25:35 -05:00
* If the queue is full, the oldest function will be removed.
*/
constructor(public maxSize = Infinity) { }
2022-10-21 22:41:33 -04:00
2022-11-25 13:25:35 -05:00
private queue = [] as Array<() => Promisable<unknown>>;
private promise?: Promise<any>;
private next() {
const func = this.queue.shift();
if (func)
this.promise = Promise.resolve()
.then(func)
2022-11-25 13:25:35 -05:00
.finally(() => this.next());
else
this.promise = undefined;
}
private run() {
if (!this.promise)
this.next();
}
2022-11-25 13:25:35 -05:00
/**
* 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();
this.queue.push(func);
this.run();
}
2022-11-25 13:25:35 -05:00
/**
* 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();
this.queue.unshift(func);
this.run();
}
2022-11-25 13:25:35 -05:00
/**
* The amount of tasks in the queue
*/
get size() {
return this.queue.length;
2022-10-21 22:41:33 -04:00
}
}