@kamikillerto/wait-js
v0.2.4
Published
The coolest way to wait
Downloads
336
Maintainers
Readme
The coolest way to wait
waitjs provides you a promise-like interface to manage postponed executions.
Installation
waitjs is available on npm and bower.
npm install --save @kamikillerto/wait-js
#or
bower install wait-js --save
This will install the waitjs library files in your project's bower_components or node_modules folder.
After you just have to add <script>
or use require
with you favorite AMD module loader.
var wait = require('@kamikillerto/wait-js');
<script src="bower_components/wait-js/src/wait.js"type="text/javascript"></script>
<!-- or -->
<script src="node_modules/@kamikillerto/wait-js/src/wait.js"type="text/javascript"></script>
API
wait([time[, occurence]])
Do the same thing as setTimeout
, delay a function call.
Instead of writing :
function delayedFn() {
//...
};
setTimeout(delayedFn, 500);
You can now write:
function delayedFn() {
//...
};
wait(500).then(delayedFn);
time
Type : number
It's the time to wait before executing the registered function.
function delayedFn() {
//...
};
wait(1000).then(delayedFn);
Here we wait 1s before calling the function delayedFn
.
occurence
Type: number
It allow to execute the wait handlers multiples times each time after the waiting time.
Instead of writing :
function delayedFn() {
//...
};
var occurence = 5,
id = setInterval(function() {
if(occurence === 0) {
return clearInterval(id);
}
delayedFn();
occurence--;
return;
}, 500);
You can now write:
function delayedFn() {
//...
};
wait(500, 5).then(delayedFn);
return Wait
Wait
A promise-like object.
Wait prototype
Wait.prototype.catch(onRejected)
Appends a rejection handler callback to the Wait.
Wait.prototype.then(onFulfilled, onRejected)
Appends fulfillment and rejection handlers to the Wait.
License
MIT