crontabjs v3.0.0

Crontab.js

the manager of setInterval and setTimeout.

The core of the idea

Maintaining a queue, iterate over all those queue and execute it if needed when every time start.

Install

npm install crontabjs

Implementation

Class

Crontab(interval, tolerance)

• interval the interval time of crontab run. unit is ms, default is 400ms.
• tolerance the maximum error of current time and last execute time. if currTime + tolerance - lastExecuteTime - intervalTime greater than 0, then this item will be run.

getInstance()

Also, you can use var crontab = Crontab.getInstance(); to get the only one instance.

This is for global invoke. return the same instance of Crontab. If no instance, create a new one.

Method

on(fn, time, context)

register a function. same as setInterval.

• time means the interval of function run. the unit is ms
• fn means the function which wait for run.
• context means the context of fn.

one(fn, time, context)

like on, register once. same as setTimeout.

off(id)

clear a item which id is id in queue. if id not set, clear all queue.

start

start run crontab. this will be auto run when use new Crontab().

stop

stop run crontab.

setInterval(fn, time, context)

alias on(fn, time[, context]).

setTimeout(fn, time, context)

alias one(fn, time[, context]).

clearTimeout(id)

alias off(id).

clearInterval(id)

alias off(id).

setIntervalTime

set the interval time of the current instance of crontab.

this will run stop and start method in turn when it invoked.

setToleranceTime

set the tolerance time of the current instance of crontab.

Test

# test in browser
npm run-script browser

# test in terminal
mocha
# or
npm run-script test

LICENSE

Apache License 2.0