robust-timers

Documentation: https://elkornacio.github.io/Robust-Timers/

Installation

$ npm install robust-timers

Example

Simple example of usage in pair with mysql native driver.

let RobustTimers = require('./index');
let mysql = require('mysql');
 
app.timers = new RobustTimers();
 
app.timers.register({
    name: 'mail checker',
    interval: 15 * 60 * 1000,
    handler: _ => new Promise((resole, reject) => {
        app.gmail.preloadAllMails()
            .then(app.gmail.loadNewMails)
            .then(app.gmail.loadAttachments)
            .then(resolve)
            .catch(reject);
    })
});
 
let conn = mysql.createConnection({
    host     : 'localhost',
    user     : 'root',
    password : 'root',
    database : 'tempTest'
});
 
conn.connect();
 
let dataSource = RobustTimers.DataSource.NativeMySQL(conn);
app.timers.assignDataSource(dataSource);
 
app.timers.restore().then(_ => r.start());

RobustTimers

Simple class used for multiple purposes regarding to timers. Except obvious functions like registering, unregistering timers, you can easily save and restore timers states, register "once" timers, activate and deactivate registered timers, provide your own handlers to serialize/unseriaize and save/restore timer states.

All functions (except asynchronous) returns context to provide fluent interface pattern.

Meant that this class will be used as singleton, but it's up to you and yours app's architecture.

Kind: global class

• RobustTimers
  • new RobustTimers(options)
  • .register(options)
  • .unregister(name)
  • .activate(name)
  • .deactivate(name)
  • .start()
  • .interval(name, interval, handler)
  • .once(name, interval, handler)
  • .restore(handler)
  • .save(handler)
  • .assignDataSource(dataSource)

new RobustTimers(options)

Just constructor.

robustTimers.register(options)

Registers new timer and runs it if needed.

Kind: instance method of RobustTimers
Throws:

• Will throw an exception if there are no handler or interval provided in options.

robustTimers.unregister(name)

Unregisters timer and stops it if needed.

Kind: instance method of RobustTimers

robustTimers.activate(name)

Starts the timer lifecycle.

Kind: instance method of RobustTimers

robustTimers.deactivate(name)

Pauses the timer lifecycle.

Kind: instance method of RobustTimers

robustTimers.start()

If all event handlers and other staff is registered, timers states are restored, and we are ready to go at all - starts all registered timers lifecycles.

Kind: instance method of RobustTimers

robustTimers.interval(name, interval, handler)

Shortcut to register simple interval-based timer. Similar to simple JS setInterval.

Kind: instance method of RobustTimers

robustTimers.once(name, interval, handler)

Shortcut to register simple timer, that should be fired only once. Similar to simple JS setTimeout.

Kind: instance method of RobustTimers

robustTimers.restore(handler)

If handler is provided - registers it as default restoring function this.__onRestoreHandler. If not - trying to restore all inner state using this.__onRestoreHandler.

Kind: instance method of RobustTimers
Throws:

• Will throw an exception if there are no restore handler, or if restore handler did not return promise.

robustTimers.save(handler)

If handler is provided - registers it as default saving function this.__onSaveHandler. If not - trying to save all inner state using this.__onSaveHandler.

Kind: instance method of RobustTimers
Throws:

• Will throw an exception if there are no save handler, or if save handler did not return promise.

robustTimers.assignDataSource(dataSource)

Registers save/restore handlers from the given object.

Kind: instance method of RobustTimers