npm.io
1.1.1 • Published 6 years ago

reraf

Licence
ISC
Version
1.1.1
Deps
0
Size
6 kB
Vulns
0
Weekly
0

reraf

Build Status Coverage Status

Social Media Photo by Hans Eiskonen on Unsplash

A super light and simple way to reschedule animation frames, compatible with every browser and Node.js through a setTimeout and clearTimeout fallback.

import reraf from 'reraf';
// or const reraf = require('reraf');
// or <script src="//unpkg.com/reraf">

const reschedule = reraf(/* optional integer limit */);

reschedule(console.log, null, ['first']);
reschedule(console.log, null, ['second']);
// will log "second", but never "first"

The reschedule(...) returns a function to be able to stop() the scheduled animation frame, in case it's needed.

If a truthy value is passed to stop(truthy), the callback will be "flushed" (invoked) if it didn't flush already.

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.

Keywords