reinterval

reInterval

Reschedulable setInterval for node.js.

Note: Work highly inspired by mcollina's retimer.

Example

var reInterval = require('reInterval');

var inter = reInterval(function () {
  console.log('this should be called after 13s');
}, 10 * 1000);

// This will reset/reschedule the interval after 3 seconds, therefore
// the interval callback won't be called for at least 13 seconds.
setTimeout(function () {
  inter.reschedule(10 * 1000);
}, 3 * 1000);

API:

###reInterval(callback, interval[, param1, param2, ...])

This is exactly like setInterval.

Arguments:

• callback: The callback to be executed repeatedly.
• interval: The number of milliseconds (thousandths of a second) that the reInterval() function should wait before each call to callback.
• param1, param2, ...: (OPTIONAL) These arguments are passed to the callback function.

####returns an interval object with the following methods:

###interval.reschedule([interval])

This function resets the interval and restarts it now.

Arguments:

• interval: (OPTIONAL) This argument can be used to change the amount of milliseconds to wait before each call to the callback passed to the reInterval() function.

###interval.clear()

This function clears the interval. Can be used to temporarily clear the interval, which can be rescheduled at a later time.

###interval.destroy()

This function clears the interval, and will also clear the callback and params passed to reInterval, so calling this essentially just makes this object ready for overwriting with a new interval object.

Note:

Please ensure that either the interval.clear() or interval.destroy() function is called before overwriting the interval object, because the internal interval can continue to run in the background unless cleared.

license

MIT

Similar packages

Other packages similar to reinterval

node-schedule

node-schedule is a flexible cron-like and not-cron-like job scheduler for Node.js. It allows you to schedule jobs using cron syntax or a Date object. Unlike reinterval, node-schedule is more focused on scheduling tasks at specific times rather than at regular intervals.

cron

The cron package is a straightforward implementation of cron jobs in Node.js. It allows you to schedule tasks using cron syntax. While it is similar to reinterval in that it can handle repeated tasks, it is more suited for tasks that need to run at specific times rather than adjustable intervals.

later

Later is a package for defining schedules and executing them in Node.js. It supports a wide range of scheduling options, including intervals, cron-like schedules, and more. Compared to reinterval, later offers more complex scheduling capabilities but may be overkill for simple interval tasks.