@mobilabs/taskq
v1.0.2
Published
A library that processes tasks sequentially
Downloads
3
Readme
TaskQ
TaskQ
is a Javascript library that allows tasks to be executed sequentially.
It is designed to be embedded in another library. TaskQ
run on both Node.js and ECMAScript 2015 (ES6) compliant browsers.
Quick Startup
This example shows how to store tasks, in the Task Queue
, that must be processed sequentially. As soon as a task is stored in the queue, it is executed. When it is completed, it launches the next task thanks to the function next
and so on until the queue is empty.
// Create the taskQ object:
const taskQ = TaskQ();
// Define an heavy tasks
function heavy(next) {
doSomethingComplex();
next();
}
// Push tasks in the Queue:
taskQ.pushQ('aaa', (next) => {
heavyTask1(next);
});
taskQ.pushQ('aaa', (next) => {
heavyTask12(next);
});
API
Static methods
TaskQ
provides one static method. You can use it by typing:
TaskQ.noConflict();
| Static Methods | Description | |:---------------------|:------------| | noConflict | returns the TaskQ variable to its previous owner |
Create a TaskQ object:
| Constructor | Description | |:------------|:------------| | TaskQ() | creates the TaskQ object that processes tasks |
Methods
| Methods | Description | |:--------------------|:------------| | pushQ(queue, task) | pushes, in a dedicated queue, a task that need to be processed after the previous one | | popQ(queue, task) | pushes, in a dedicated queue, a task that need to be processed just after the running task is completed |
License
MIT.