├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── cjs
    ├── index.js
    └── package.json
├── esm
    └── index.js
├── index.js
├── min.js
├── package.json
├── rollup
    └── index.config.js
└── test
    └── index.js


/.gitignore:
--------------------------------------------------------------------------------
1 | coverage/
2 | node_modules/
3 | package-lock.json
4 | 


--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | coverage/
2 | node_modules/
3 | rollup/
4 | test/
5 | package-lock.json
6 | .travis.yml
7 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: node_js
 2 | node_js:
 3 |   - stable
 4 | git:
 5 |   depth: 1
 6 | branches:
 7 |   only:
 8 |     - master
 9 | after_success:
10 |   - "npm run coveralls"
11 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | ISC License
 2 | 
 3 | Copyright (c) 2019, Andrea Giammarchi, @WebReflection
 4 | 
 5 | Permission to use, copy, modify, and/or distribute this software for any
 6 | purpose with or without fee is hereby granted, provided that the above
 7 | copyright notice and this permission notice appear in all copies.
 8 | 
 9 | THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
10 | REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
11 | AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
12 | INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
13 | LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
14 | OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
15 | PERFORMANCE OF THIS SOFTWARE.
16 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # reraf
 2 | 
 3 | [![Build Status](https://travis-ci.com/WebReflection/reraf.svg?branch=master)](https://travis-ci.com/WebReflection/reraf) [![Coverage Status](https://coveralls.io/repos/github/WebReflection/reraf/badge.svg?branch=master)](https://coveralls.io/github/WebReflection/reraf?branch=master)
 4 | 
 5 | <sup>**Social Media Photo by [Hans Eiskonen](https://unsplash.com/@eiskonen) on [Unsplash](https://unsplash.com/)**</sup>
 6 | 
 7 | A super light and simple way to reschedule animation frames, compatible with every browser and Node.js through a `setTimeout` and `clearTimeout` fallback.
 8 | 
 9 | ```js
10 | import reraf from 'reraf';
11 | // or const reraf = require('reraf');
12 | // or <script src="//unpkg.com/reraf">
13 | 
14 | const reschedule = reraf(/* optional integer limit */);
15 | 
16 | reschedule(console.log, null, ['first']);
17 | reschedule(console.log, null, ['second']);
18 | // will log "second", but never "first"
19 | ```
20 | 
21 | The `reschedule(...)` returns a function to be able to `stop()` the scheduled animation frame, in case it's needed.
22 | 
23 | If a `truthy` value is passed to `stop(truthy)`, the callback will be "flushed" (invoked) if it didn't flush already.
24 | 
25 | The `stop(...)` function returns a boolean value, indicating the stop actually stopped the execution of the callback, or it didn't, 'cause it happened before.
26 | 


--------------------------------------------------------------------------------
/cjs/index.js:
--------------------------------------------------------------------------------
 1 | 'use strict';
 2 | var compat = typeof cancelAnimationFrame === 'function';
 3 | var cAF = compat ? cancelAnimationFrame : clearTimeout;
 4 | var rAF = compat ? requestAnimationFrame : setTimeout;
 5 | function reraf(limit) {
 6 |   var force, timer, callback, self, args;
 7 |   reset();
 8 |   return function reschedule(_callback, _self, _args) {
 9 |     callback = _callback;
10 |     self = _self;
11 |     args = _args;
12 |     if (!timer)
13 |       timer = rAF(invoke);
14 |     if (--force < 0)
15 |       stop(true);
16 |     return stop;
17 |   };
18 |   function invoke() {
19 |     reset();
20 |     callback.apply(self, args || []);
21 |   }
22 |   function reset() {
23 |     force = limit || Infinity;
24 |     timer = compat ? 0 : null;
25 |   }
26 |   function stop(flush) {
27 |     var didStop = !!timer;
28 |     if (didStop) {
29 |       cAF(timer);
30 |       if (flush)
31 |         invoke();
32 |     }
33 |     return didStop;
34 |   }
35 | }
36 | module.exports = reraf;
37 | 


--------------------------------------------------------------------------------
/cjs/package.json:
--------------------------------------------------------------------------------
1 | {"type":"commonjs"}


--------------------------------------------------------------------------------
/esm/index.js:
--------------------------------------------------------------------------------
 1 | var compat = typeof cancelAnimationFrame === 'function';
 2 | var cAF = compat ? cancelAnimationFrame : clearTimeout;
 3 | var rAF = compat ? requestAnimationFrame : setTimeout;
 4 | export default function reraf(limit) {
 5 |   var force, timer, callback, self, args;
 6 |   reset();
 7 |   return function reschedule(_callback, _self, _args) {
 8 |     callback = _callback;
 9 |     self = _self;
10 |     args = _args;
11 |     if (!timer)
12 |       timer = rAF(invoke);
13 |     if (--force < 0)
14 |       stop(true);
15 |     return stop;
16 |   };
17 |   function invoke() {
18 |     reset();
19 |     callback.apply(self, args || []);
20 |   }
21 |   function reset() {
22 |     force = limit || Infinity;
23 |     timer = compat ? 0 : null;
24 |   }
25 |   function stop(flush) {
26 |     var didStop = !!timer;
27 |     if (didStop) {
28 |       cAF(timer);
29 |       if (flush)
30 |         invoke();
31 |     }
32 |     return didStop;
33 |   }
34 | };
35 | 


--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
 1 | var reraf = (function (exports) {
 2 |   'use strict';
 3 | 
 4 |   var compat = typeof cancelAnimationFrame === 'function';
 5 |   var cAF = compat ? cancelAnimationFrame : clearTimeout;
 6 |   var rAF = compat ? requestAnimationFrame : setTimeout;
 7 |   function reraf(limit) {
 8 |     var force, timer, callback, self, args;
 9 |     reset();
10 |     return function reschedule(_callback, _self, _args) {
11 |       callback = _callback;
12 |       self = _self;
13 |       args = _args;
14 |       if (!timer)
15 |         timer = rAF(invoke);
16 |       if (--force < 0)
17 |         stop(true);
18 |       return stop;
19 |     };
20 |     function invoke() {
21 |       reset();
22 |       callback.apply(self, args || []);
23 |     }
24 |     function reset() {
25 |       force = limit || Infinity;
26 |       timer = compat ? 0 : null;
27 |     }
28 |     function stop(flush) {
29 |       var didStop = !!timer;
30 |       if (didStop) {
31 |         cAF(timer);
32 |         if (flush)
33 |           invoke();
34 |       }
35 |       return didStop;
36 |     }
37 |   }
38 | 
39 |   
40 | 
41 |   return reraf;
42 | 
43 | }({}));
44 | 


--------------------------------------------------------------------------------
/min.js:
--------------------------------------------------------------------------------
1 | var reraf=function(){"use strict";var r="function"==typeof cancelAnimationFrame,m=r?cancelAnimationFrame:clearTimeout,l=r?requestAnimationFrame:setTimeout;return function(n){var e,i,u,a,c;return t(),function(n,t,r){return u=n,a=t,c=r,i=i||l(o),--e<0&&f(!0),f};function o(){t(),u.apply(a,c||[])}function t(){e=n||1/0,i=r?0:null}function f(n){var t=!!i;return t&&(m(i),n&&o()),t}}}();


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "reraf",
 3 |   "version": "1.1.1",
 4 |   "description": "A super light and simple way to reschedule animation frames",
 5 |   "main": "cjs/index.js",
 6 |   "scripts": {
 7 |     "build": "npm run cjs && npm run rollup && npm run clean && npm run min && npm run test",
 8 |     "cjs": "ascjs --no-default esm cjs",
 9 |     "clean": "sed -i 's/exports.default = reraf;//' index.js && sed -i 's/return exports/return reraf/' index.js",
10 |     "coveralls": "cat ./coverage/lcov.info | coveralls",
11 |     "rollup": "rollup --config rollup/index.config.js",
12 |     "min": "uglifyjs index.js -mco min.js",
13 |     "test": "istanbul cover test/index.js"
14 |   },
15 |   "keywords": [
16 |     "requestAnimationFrame",
17 |     "schedule",
18 |     "cancel"
19 |   ],
20 |   "author": "Andrea Giammarchi",
21 |   "license": "ISC",
22 |   "devDependencies": {
23 |     "ascjs": "^3.1.2",
24 |     "coveralls": "^3.0.9",
25 |     "istanbul": "^0.4.5",
26 |     "rollup": "^1.27.9",
27 |     "rollup-plugin-node-resolve": "^5.2.0",
28 |     "uglify-js": "^3.7.2"
29 |   },
30 |   "module": "esm/index.js",
31 |   "unpkg": "min.js"
32 | }
33 | 


--------------------------------------------------------------------------------
/rollup/index.config.js:
--------------------------------------------------------------------------------
 1 | import resolve from 'rollup-plugin-node-resolve';
 2 | 
 3 | export default {
 4 |   input: './esm/index.js',
 5 |   plugins: [
 6 |     
 7 |     resolve({module: true})
 8 |   ],
 9 |   
10 |   output: {
11 |     exports: 'named',
12 |     file: './index.js',
13 |     format: 'iife',
14 |     name: 'reraf'
15 |   }
16 | };
17 | 


--------------------------------------------------------------------------------
/test/index.js:
--------------------------------------------------------------------------------
 1 | var reraf = require('../cjs')();
 2 | var self = {};
 3 | var args = [1, 2];
 4 | reraf(function () {
 5 |   console.assert(this === self, 'unexpected context');
 6 |   console.assert(args.join(',') === args.join.call(arguments, ','), 'unexpected arguments');
 7 |   delete require.cache[require.resolve('../cjs')];
 8 |   global.cancelAnimationFrame = clearTimeout;
 9 |   global.requestAnimationFrame = setTimeout;
10 |   global.clearTimeout = null;
11 |   var reraf = require('../cjs')();
12 |   reraf(function () {
13 |     console.assert(this === self, 'unexpected context');
14 |     console.assert('' === args.join.call(arguments, ','), 'unexpected arguments');
15 |     var reraf = require('../cjs')(1);
16 |     var calls = 0;
17 |     reraf(function () {
18 |       console.assert(false, 'this should never happen');
19 |     });
20 |     reraf(function () {
21 |       console.assert(calls === 0, 'unexpected delay');
22 |       reraf(function () {
23 |         console.assert(false, 'this should not have happened');
24 |       })();
25 |       reraf = require('../cjs')();
26 |       var times = 0;
27 |       var stop = reraf(function () {
28 |         console.assert(0 === times++, 'flushed twice should never happen');
29 |         console.log('OK');
30 |       });
31 |       stop(true);
32 |       stop(true);
33 |     });
34 |     calls++;
35 |   }, self);
36 | }, self, args);
37 | 


--------------------------------------------------------------------------------