Class: RobustTimers

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.

Constructor

new RobustTimers(options)

Just constructor.
Parameters:
Name Type Description
options Object object containing options for construction.
Properties
Name Type Description
start boolean if true - calls this.start() at the end of construction.
restoreAndStart boolean if true - calls this.restore() and after restoring states calls this.start(). Use only makes sense in combination with the provided options.dataSource param.
dataSource Object data source object. You can see object description at this.assignDataSource() method.
Source:

Methods

activate(name)

Starts the timer lifecycle.
Parameters:
Name Type Description
name string name of the timer.
Source:

assignDataSource(dataSource)

Registers save/restore handlers from the given object.
Parameters:
Name Type Description
dataSource Object object with two properties "save" and "restore" containing save and restore functions respectively. THIS OBJECT IS NOT USED AS A CONTEXT WHEN THIS FUNCTIONS ARE CALLED!
Source:

deactivate(name)

Pauses the timer lifecycle.
Parameters:
Name Type Description
name string name of the timer.
Source:

interval(name, interval, handler)

Shortcut to register simple interval-based timer. Similar to simple JS setInterval.
Parameters:
Name Type Description
name string name of the timer.
interval number interval of the timer.
handler function handler of the timer.
Source:

once(name, interval, handler)

Shortcut to register simple timer, that should be fired only once. Similar to simple JS setTimeout.
Parameters:
Name Type Description
name string name of the timer.
interval number interval of the timer.
handler function handler of the timer.
Source:

register(options)

Registers new timer and runs it if needed.
Parameters:
Name Type Description
options Object object containing options of timer.
Properties
Name Type Description
name string name of the timer. Unique. Will be generated if not provided. All methods works with this name.
active boolean if true - timer is active (and will be started immediatly if this.start() was already called).
handler function timer's handler - function which called every time timer is fired. If options.isOnce is true - will be called once. Required.
isOnce boolean if true - after first timer's firing timer will be unregistered.
lastExecutionTimestamp number if timer was already fired in past this param should contain last execution timestamp (in ms) - it will be used to calculate correctly next execution time.
interval number timer's execution interval. In milliseconds. Required.
context Object context that will be provided to the timer's handler when it's executing.
Source:
Throws:
Will throw an exception if there are no handler or interval provided in options.

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.
Parameters:
Name Type Default Description
handler function null async function that gets one param - this instance and should restore all it's inner state basing on anything (DB/Local Storage/etc.).
Source:
Throws:
Will throw an exception if there are no restore handler, or if restore handler did not return promise.

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.
Parameters:
Name Type Default Description
handler function null async function that gets one param - this instance and should save all it's inner state in anywhere (DB/Local Storage/etc.).
Source:
Throws:
Will throw an exception if there are no save handler, or if save handler did not return promise.

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.
Source:

unregister(name)

Unregisters timer and stops it if needed.
Parameters:
Name Type Description
name string name of the timer.
Source: