mock-raf

A simple mock for requestAnimationFrame testing with fake timers.

Adapted with gratitude from react-motion. Original source here.

Basic Usage

``js
var createMockRaf = require('mock-raf');
var mockRaf = createMockRaf();

// Stub out your requestAnimationFrame method
sinon.stub(window, 'requestAnimationFrame').callsFake(mockRaf.raf);

// Take 10 requestAnimationFrame steps (your callback will fire 10 times)
mockRaf.step({ count: 10 });
`

API

$3

Creates a mockRaf instance, exposing the functions you'll use to interact with the mock.

Returns:

- now()
- raf()
- cancel()
- step()

`js
var mockRaf = createMockRaf();
`

$3

Returns the current now value of the mock. Starts at 0 and increases with each step() taken. Useful for stubbing out performance.now() or a polyfill when using requestAnimationFrame with timers.

$3

Replacement for requestAnimationFrame or a polyfill. Adds a callback to be fired on the next step.

$3

Replacement for cancelAnimationFrame or a polyfill. Removes all currently scheduled requestAnimationFrame callbacks from the queue.

$3

Takes requestAnimationFrame steps. Fires currently queued callbacks for each step and increments now time for each step. The primary way to interact with a mockRaf instance for testing.

#### Options

step() takes an optional options object:

##### time

Type: Number Default: 1000 / 60

The time that should pass during each requestAnimationFrame step in milliseconds. Default is roughly equivalent to default browser behavior.

##### count

Type: Number Default: 1`

The number of steps to take.