1.0.1 • Published 4 years ago
process-handler v1.0.1
Process handler
This handler helps you to handle multiple promises effortlessly. This library will handle processes and its sub processes and its sub process and so on...
Simplest Code
var processQueue = new ProcessQueue;
var process1 = new Process(function(){/* promise invoker function */});
processQueue.push(process1);
var process2...
var process3 ...
Developers
Build dist Just a simple node program run on build.js file.
- Make sure you have npm and node installed. If not click here
- On terminal do the following
git clone https://github.com/abhayjatindoshi/process-handler.git
cd process-manager/
npm install
node build.js
Dependencies
- UIkit → Used for rendering the process UI
API
Process
Syntax
new Process(invokingFunction);
new Process(promise);
- invokingFunction → function that should be invoked inside the Promise
- promise → or Promise object itself
Methods
then(resolve,reject);
- resolve, reject → functions that we pass to a Promise
catch(reject);
- reject → function that we pass to a Promise
getStatus()
- gets the current status of this process
ProcessQueue
Syntax
new ProccessQueue();
Methods
push(Process);
push(ProcessQueue);
- any
Process
orProcessQueue
type of object can be pushed into the queue
then(resolve,reject);
- resolve, reject → functions that we pass to a Promise
catch(reject);
- reject → function that we pass to a Promise
getStatus()
- gets the current status of this queue
DecoratedProcess
Syntax
new DecoratedProcess(invokingFunction[,title]);
new DecoratedProcess(promise[,title]);
- invokingFunction → function that should be invoked inside the Promise
- promise → or Promise object itself
- title → initial title to display on DOM
Methods
All the methods from Process and the ones below.
appendToElement(DOMElement);
- DOMElement → to attach the DecoratedProcess UI to a DOMElement
updateTitle(title);
- updates the title in the DOM
DecoratedProcessQueue
Syntax
new DecoratedProcessQueue([title]);
- title → initial title to display on DOM
Methods
All the methods from ProcessQueue and the ones below.
appendToElement(DOMElement);
- DOMElement → to attach the DecoratedProcessQueue to a DOMElement
updateTitle(title);
- updates the title in the DOM