Package Exports

retimer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (retimer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

retimer

reschedulable setTimeout for you node needs. This library is built for building a keep alive functionality across a large numbers of clients/sockets.

Rescheduling a 10000 functions 20 times with an interval of 50ms (see bench.js), with 100 repetitions:

benchSetTimeout*100: 51867ms
benchRetimer*100: 34237ms

Install

npm install retimer --save

Example

var retimer = require('retimer')
var timer = retimer(function () {
  throw new Error('this should never get called!')
}, 20)

setTimeout(function () {
  timer.reschedule(50)
  setTimeout(function () {
    timer.clear()
  }, 10)
}, 10)

API

retimer(callback, timeout, [...args])

Exactly like your beloved setTimeout. Returns a Retimer object

timer.reschedule(timeout)

Reschedule the timer, if the specified timeout comes after the original timeout.

Returns true if successful, false otherwise

timer.clear()

Clear the timer, like your beloved clearTimeout.

How it works

Timers are stored in a Linked List in node.js, if you create a lot of timers this Linked List becomes massive which makes removing a timer an expensive operation. Retimer let the old timer run at its time, and schedule a new one accordingly.

License

MIT