npm

Need private packages and team management tools?Check out npm Orgs. »

rafael

4.3.1 • Public • Published

Rafael

npm Bower Open Github Issues Dependencies Travis CI Build

Rafael.js is a simple client side rafael based on the requestAnimationFrame loop. Typically you may use something like window.setInterval() or window.setTimeout() to achieve this.

However, requestAnimationFrame allows us to utilize the GPU, avoiding the performance bottlenecks of those other methods. requestAnimationFrame is intended to allow Javascript animations to utilize the computer's GPU so it can be handled at ~60fps (performance depends on the machine). Rafael just makes it easy to control multiple tasks running on the requestAnimationFrame loop.

NOTE: This plugin will make it really, really, really easy to bog down your app. Schedule with caution.

Usage

Create a new instance of Rafael:

var rafael = new Rafael;

Now let's schedule something:

var foo = function () {
  console.log('Do a thing.');
};
 
rafael.schedule('foo', foo);

Then let's stop it:

rafael.unschedule('foo');

Boom. Now let's get crazy:

var fooCounter = 0;
var barCounter = 0;
 
var foo = function () {
  console.log('foo has run ' + fooCounter + ' times.');
  fooCounter++;
};
 
var bar = function () {
  console.log('bar has run ' + barCounter + ' times.');
  barCounter++;
};
 
rafael.schedule('foo', foo);
rafael.schedule('bar', bar);
 
setTimeout(function () {
  rafael.unschedule('foo');
}, 1000)

Rafael will be happy to run as many tasks as you want to give it.

API

new Rafael

Creates and returns a new instance of Rafael.

Rafael.schedule(taskId, task[, options])

The schedule() method adds a task to the schedule, causing it to run on every iteration of the schedule loop. Returns the task's ID.

Parameter Required/Optional Description
taskId optional A string used to manipulate the task within the context of the Rafael. If an ID is not passed then the task's ID will be it's index in Rafael.tasks.
task required The function to be run.
options optional This is a hash of options to be considered for the task.

Options

Option Type Default Description
context Object window The value of this within the task
framerate Number 60 The number of times the task should run per second. Max is 60.
paused Boolean false Whether or not the task should start immediately. Tasks that receive paused can be kicked off with Rafael.start.

Rafael.unschedule(taskId)

The unschedule() method removes a task from the schedule and stops it from running. Returns a success boolean.

Parameter Required/Optional Description
taskId required The task to be removed from the schedule. This will completely remove the task from the Rafael so it cannot be restarted.

Rafael.pause([taskId])

The pause() method pauses a task without removing it from the schedule. The task can later be restarted with start().

Parameter Required/Optional Description
taskId optional The task to be paused. If no taskId is passed, the entire rafael will be paused.

Rafael.start([taskId])

The start() method restarts a paused task.

Parameter Required/Optional Description
taskId optional The task to be started. If no taskId is passed, the entire rafael will be started.

Rafael.clear()

Removes all tasks from the rafael.

Keywords

none

install

npm i rafael

Downloadsweekly downloads

9

version

4.3.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability