@ircam/ticker NPM

@ircam/ticker

Execute a given callback at periodic interval, trying to minimize drift and jitter.

Install

npm install [--save] @ircam/ticker

Usage

import Ticker from '@ircam/ticker'

const period = 50; // in milliseconds
const ticker = new Ticker(period, (logicalTime, currentTime, error) => {
  console.log(logicalTime, currentTime, error);
});

ticker.start();

API

Ticker

Precise periodic timer (based on setTimeout) that monitor and adapt itself to stay close to the given therical period. In particular, try to minimize the drift caused by the use of a raw setTimeout. Observed average jitter is around +/- 2ms.

Kind: global class

Ticker
- new Ticker(period, callback, options)
- .period : Number
- .start()
- .stop()

new Ticker(period, callback, options)

Param	Type	Description
period	Number	period of the timer interval in milliseconds (floored if float is given)
callback	TickerCallback	callback to execute on each tick
options	Object	additionnal options
options.errorThreshold	Number	Threshold error where the timer considers itself as out of bounds. Increasing this value tends to increase the overall jitter.