Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
79 lines (57 sloc) 2.09 KB

node-cron

Build Status

Originally this projet was a NodeJS fork of James Padolsey's cron.js.

After Craig Condon made some updates and changes to the code base this has evolved to something that has a bit of both. The cron syntax parsing is mostly James' while using timeout instead of interval is Craig's.

Additionally, this library goes beyond the basic cron syntax and allows you to supply a Date object. This will be used as the trigger for your callback. Cron syntax is still an acceptable CronTime format.

Usage:

var cronJob = require("cron").CronJob;
cronJob("* * * * * *", function(){
    console.log("You will see this message every second");
});

Available Cron patterns:

Asterisk. E.g. *
Ranges. E.g. 1-3,5
Steps. E.g. */2

Read up on cron patterns here.

Another example

var cronJob = require("cron").CronJob;
cronJob("00 30 11 * * 2-6", function(){
    // Runs every weekday (Monday through Friday)
    // at 11:30:00 AM. It does not run on Saturday
    // or Sunday.
});

How to check if a cron pattern is valid:

try {
    cronJob("invalid cron pattern", function() {
        console.log("this should not be printed");
    })
}
catch (ex) {
    console.log("cron pattern not valid");
}

Install

From source: `npm install`
From npm: `npm install cron`

Contributors

License

MIT