queue.flush()

Flushes tasks currently in the task queue based on meta.priority. When complete, calls the onComplete callback.

priorityQueue.enqueue( console.log, console, [ "world" ], { priority: 5 } );
priorityQueue.enqueue( console.log, console, [ "hello" ], { priority: 1 } );
priorityQueue.enqueue( console.log, console, [ "!" ], { priority: 7 } );

priorityQueue.flush();

// console.logs "hello"
// console.logs "world"
// console.logs "!"

If a PriorityQueue is currently flushing tasks, it prevents additional calls to flush from running tasks. This makes it so each task function finishes running before others are started as demonstrated below:

queue.enqueue( function() {
   console.log( "task 1 - start" );
   queue.flush();
   console.log( "task 1 - end" );
} );

queue.enqueue( function() {
   console.log( "task 2 - start" );
   console.log( "task 2 - end" );
} );

queue.flush();

// console.logs
//    task 1 - start
//    task 1 - end
//    task 2 - start
//    task 2 - end

If the queue's tasks are currently being flushed, new tasks added will be run without needing to call .flush() again.