better-interval
v1.0.9
Published
It works similar to `setInterval`, but under the hood it uses requestAnimationFrame to achieve the same goal. So it's less buggy.
Downloads
22
Readme
BetterInterval
It works similar to setInterval
, but under the hood it uses requestAnimationFrame to achieve the same goal. So it's less buggy.
NOTICE
- Works in browsers, not on servers.
- Supports CommonJS, so you can use it with tools like Browserify or Webpack.
Why not just use setInterval?
- setInterval keeps running event when the browser tab or window is not active.
- When the callback function takes longer to finish than the interval you set, it will not wait for the function thus resulting in enqueuing of multiple callback functions.
See more: Better Performance With requestAnimationFrame by Luz Caballero
Quck Start
1. Download
<script src="https://unpkg.com/better-interval/dist/better-interval.min.js"></script>
or if you use module bundler such as Browserify:
npm install --save better-interval
2. Import
var BetterInterval = require("better-interval");
or
import BetterInterval from 'better-interval'
Usage
Constructor
var betterInterval = new BetterInterval(callback [, interval] [, ...args])
callback:
- Repetitively executing function
- type:
function
interval:
- Time gap between each loop. By default it matches the display refresh rate of browser, which usually is 60 fps. So it's default value is approximately 16.7 (≈1000/60)
- type:
number
(milliseconds) - optional
args:
- The rest arguments. They will be passed in to the callback.
Methods:
- Start looping
betterInterval.set()
- Stop looping
betterInterval.clear()
Example
- Use BetterInterval to make a moving box animation. It moves 3 pixels per 100 milliseconds until the offset reaches 1000.
var box = document.querySelector("#box");
var offset = 0;
var betterInterval = new BetterInterval(function (increment, max) {
offset += increment;
box.style.left = offset + "px";
if (offset >= max) {
betterInterval.clear()
}
}, 100, 3, 1000);
betterInterval.set()