https://github.com/tomaskraus/real-scheduler

Executes your callback repeatedly. Avoids the excessive accumulation of timing errors in the long-run.
https://github.com/tomaskraus/real-scheduler

Last synced: 24 days ago
JSON representation

Executes your callback repeatedly. Avoids the excessive accumulation of timing errors in the long-run.

• Host: GitHub
• URL: https://github.com/tomaskraus/real-scheduler
• Owner: tomaskraus
• License: mit
• Created: 2017-06-12T21:32:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-12T13:32:57.000Z (10 months ago)
• Last Synced: 2024-11-30T11:16:35.863Z (about 1 month ago)
• Language: JavaScript
• Size: 296 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
real-scheduler

==================

[![Build Status](https://travis-ci.org/tomaskraus/real-scheduler.svg?branch=master)](https://travis-ci.org/tomaskraus/real-scheduler/)

[![Coverage Status](https://coveralls.io/repos/github/tomaskraus/real-scheduler/badge.svg)](https://coveralls.io/github/tomaskraus/real-scheduler)

Executes your callback repeatedly. Unlike the built-in [setInterval](https://nodejs.org/api/timers.html#timers_setinterval_callback_delay_args) method, real-scheduler avoids the excessive accumulation of timing errors in the long-run by making delay adjustments after each callback call.

Installation

------------

`npm install real-scheduler`

Usage

-----

executes a `callback` every `delay` milliseconds:

```javascript

    new RealScheduler(callback, delay);

```

complete example

```javascript

var RealScheduler = require('real-scheduler');

// create a Scheduler and run it automatically

// sch is a Scheduler's instance passed to a callback function

var scheduler = new RealScheduler((sch) => {

        console.log(

            // a real, accumulated time since the scheduler's start

            sch.getTimeElapsed() +

            // how many times this callback was called since the scheduler's start

            ": Call count: " + sch.getNumberOfCalls()

        );

        if (sch.getNumberOfCalls() == 60) {

            sch.stop(); //stop the scheduler

        }

    },

    100); //repeat every 100 milliseconds

```

Options

-------

You can pass an options object as the Scheduler constructor's 3rd parameter:

```javascript

    // sch is a Scheduler's instance

    var myOnStopHandler = function(sch) {

        console.log("on stop called");

    }

    new RealScheduler(callback, delay, {waitForTheFirstCall: false,

    onStop: myOnStopHandler});

```

Following optional parameters are possible:

* **waitForTheFirstCall** {boolean} - If true, waits for `delay` milliseconds before the first callback execution. Defaults to `true`.

* **onStop** {function} - A callback, called after a scheduler's `stop()` method is called. A function `(sch) => {}` where `sch` is an enclosing RealScheduler instance. Defaults to `null`.

* **onDeltaError** {function} - A callback, called after a time difference greater than `delay` occured. A function `(sch) => {}` where `sch` is an enclosing RealScheduler instance. Defaults to `null`.