Queue
Defined in: utils/promise/Queue.ts:16
A class representing a queue of promises.
Type Parameters
Section titled “Type Parameters”T = any | void
The type of the values that the promises in the queue resolve to.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Queue<
T>(promises):Queue<T>
Defined in: utils/promise/Queue.ts:26
Creates a new Queue.
Parameters
Section titled “Parameters”promises
Section titled “promises”(Promise<any> | () => Promise<T>)[] = []
The promises to add to the queue.
Returns
Section titled “Returns”Queue<T>
Accessors
Section titled “Accessors”progress
Section titled “progress”Get Signature
Section titled “Get Signature”get progress():
number
Defined in: utils/promise/Queue.ts:44
Gets the progress of the queue.
Returns
Section titled “Returns”number
The progress (0-1)
results
Section titled “results”Get Signature
Section titled “Get Signature”get results():
T[]
Defined in: utils/promise/Queue.ts:36
Gets the results of the promises that have been resolved so far.
Returns
Section titled “Returns”T[]
The results.
Methods
Section titled “Methods”add(…
args):void
Defined in: utils/promise/Queue.ts:52
Adds promises to the queue.
Parameters
Section titled “Parameters”…(Promise<any> | () => Promise<T>)[]
The promises to add.
Returns
Section titled “Returns”void
cancel()
Section titled “cancel()”cancel():
void
Defined in: utils/promise/Queue.ts:87
Cancels the execution of the promises in the queue.
Returns
Section titled “Returns”void
pause()
Section titled “pause()”pause():
void
Defined in: utils/promise/Queue.ts:70
Pauses the execution of the promises in the queue.
Returns
Section titled “Returns”void
resume()
Section titled “resume()”resume():
void
Defined in: utils/promise/Queue.ts:77
Resumes the execution of the promises in the queue.
Returns
Section titled “Returns”void
start()
Section titled “start()”start():
void
Defined in: utils/promise/Queue.ts:59
Starts the execution of the promises in the queue.
Returns
Section titled “Returns”void