UNPKG

892 BTypeScriptView Raw
1/**
2 * A simple queue with optional priority.
3 */
4export declare class Queue extends Object {
5 /**
6 * Queue data.
7 */
8 private _queue_;
9 constructor();
10 /**
11 * Get size of queue.
12 *
13 * @returns Total callbacks in queue.
14 */
15 get size(): number;
16 /**
17 * Clear queue.
18 */
19 clear(): void;
20 /**
21 * Enqueue callback.
22 *
23 * @param handler Callback function.
24 * @param priority Callback priority.
25 */
26 push(handler: () => Promise<any>, priority?: number): void;
27 /**
28 * Pop callback off queue.
29 *
30 * @returns Callback function or null if empty.
31 */
32 pop(): (() => Promise<any>) | null;
33 /**
34 * Shift callback off queue.
35 *
36 * @returns Callback function or null if empty.
37 */
38 shift(): (() => Promise<any>) | null;
39 /**
40 * Run queue.
41 */
42 run(): Promise<void>;
43}