ActionQueue

class Util.ActionQueue(): A queue of [Action]s to be evaluated. Some number of actions are allowed to be active at once Settable via the constructor.

Constructors

constructor()

Methods

isIdle()
push()
waitForIdle()

Constructors

ActionQueue.constructor(maxActivePromises, suppressFailures)

Arguments

maxActivePromises (number()) – Max number of promises to leave open before they begin getting deferred
suppressFailures (boolean()) – Whether or not rejected promises and actions that throw cause the queue to fail

Creates a new [ActionQueue]

Return type: ActionQueue

Methods

isIdle

ActionQueue.isIdle()

Returns true if there are no actions waiting to be evaluated

Returns: Boolean indicating idle status
Return type: boolean

push

ActionQueue.push(action)

Arguments

action (ActionLike()) – None

Pushes a new [ActionLike] to be evaluated onto the queue

Return type: void

waitForIdle

ActionQueue.waitForIdle()

Returns a Promise<void> that resolves when all actions have been completed or rejects if there was a failure

It should be noted that if the queue is configured not to suppress failures and an action throws an error, any deferred actions (actions that were queued but not active at the time of the failure) will be cleared from the queue and will not be evaluated

Returns: A promise that resolves/rejects when all actions have been completed
Return type: Promise <void>