Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

raf-engine

0.3.0 • Public • Published

raf-engine

A js RAF engine

Usage

import RAFEngine from 'raf-engine';
 
// Create the engine
const engine = new RAFEngine();
const fn = () => {
  // Awesome stuff executed each frame
};
// Add a function to the quee and take the id
const id = engine.add(fn);
// Add a function by manually setting the id
engine.add(fn, 'myId');
// Add a function and make it executed at half the speed (jump odd frames)
engine.add(fn, 'heavyId', true);
 
// Time to start the engine
engine.start();
 
// Remove a function by id, the engine will auto-stop when the last function is removed
engine.remove(id);
 
// Or stop it manually
engine.stop();
// By passing true to force you can also cancel the last queed frame just to be sure
// it won't be executed, otherwise the already requested frames will be executed
engine.stop(true);
 
// You can also check the running state by testing the .stopped property
if (!engine.stopped) {
  engine.stop();
}

Install

npm i raf-engine

DownloadsWeekly Downloads

6

Version

0.3.0

License

ISC

Unpacked Size

47.6 kB

Total Files

7

Last publish

Collaborators

  • avatar