Node Schedule is a flexible cron-like and not-cron-like job scheduler for Node.js. It allows you to schedule jobs (arbitrary functions) for execution at specific dates, with optional recurrence rules. It only uses a single timer at any given time (rather than reevaluating upcoming jobs every second/minute).
You can install using npm.
npm install node-schedule
Node Schedule is for time-based scheduling, not interval-based scheduling.
While you can easily bend it to your will, if you only want to do something like
"run this function every 5 minutes", you'll find
setInterval much easier to use,
and far more appropriate. But if you want to, say, "run this function at the :20
and :50 of every hour on the third Tuesday of every month," you'll find that
Node Schedule suits your needs better. Additionally, Node Schedule has Windows
support unlike true cron since the node runtime is now fully supported.
Note that Node Schedule is designed for in-process scheduling, i.e. scheduled jobs will only fire as long as your script is running, and the schedule will disappear when execution completes. If you need to schedule jobs that will persist even when your script isn't running, consider using actual cron.
Jobs and Scheduling
Every scheduled job in Node Schedule is represented by a
Job object. You can
create jobs manually, then execute the
schedule() method to apply a schedule,
or use the convenience function
scheduleJob() as demonstrated below.
Job objects are
EventEmitter's, and emit a
run event after each execution.
They also emit a
scheduled event each time they're scheduled to run, and a
canceled event when an invocation is canceled before it's executed (both events
first time immediately, so if you create a job using the
convenience method, you'll miss the first
scheduled event, but you can query the
invocation manually (see below). Also note that
canceled is the single-L American
The cron format consists of:
* * * * * * ┬ ┬ ┬ ┬ ┬ ┬ │ │ │ │ │ │ │ │ │ │ │ └ day of week (0 - 7) (0 or 7 is Sun) │ │ │ │ └───── month (1 - 12) │ │ │ └────────── day of month (1 - 31) │ │ └─────────────── hour (0 - 23) │ └──────────────────── minute (0 - 59) └───────────────────────── second (0 - 59, OPTIONAL)
Examples with the cron format:
var schedule = ;var j = schedule;
Execute a cron job when the minute is 42 (e.g. 19:42, 20:42, etc.).
var j = schedule;
Execute a cron job every 5 Minutes = */5 * * * *
You can also get when it is scheduled to run for every invocation of the job:
var j = schedule;
This is useful when you need to check if there is a delay of the job invocation when the system is busy, or save a record of all invocations of a job for audit purpose.
Unsupported Cron Features
W (nearest weekday),
L (last day of month/week), and
# (nth weekday
of the month) are not supported. Most other features supported by popular cron
implementations should work just fine.
cron-parser is used to parse crontab instructions.
var schedule = ;var date = 2012 11 21 5 30 0;var j = schedule;
To use current data in the future you can use binding:
var schedule = ;var date = 2012 11 21 5 30 0;var x = 'Tada!';var j = schedule;x = 'Changing Data';
This will log 'Tada!' when the scheduled Job runs, rather than 'Changing Data', which x changes to immediately after scheduling.
Recurrence Rule Scheduling
You can build recurrence rules to specify when a job should recur. For instance, consider this rule, which executes the function every hour at 42 minutes after the hour:
var schedule = ;var rule = ;ruleminute = 42;var j = schedule;
You can also use arrays to specify a list of acceptable values, and the
object to specify a range of start and end values, with an optional step parameter.
For instance, this will print a message on Thursday, Friday, Saturday, and Sunday at 5pm:
var rule = ;ruledayOfWeek = 0 4 6;rulehour = 17;ruleminute = 0;var j = schedule;
dayOfWeek (0-6) Starting with Sunday
Note: It's worth noting that the default value of a component of a recurrence rule is
null(except for second, which is 0 for familiarity with cron). If we did not explicitly set
minuteto 0 above, the message would have instead been logged at 5:00pm, 5:01pm, 5:02pm, ..., 5:59pm. Probably not what you want.
Object Literal Syntax
To make things a little easier, an object literal syntax is also supported, like in this example which will log a message every Sunday at 2:30pm:
var j = schedule;
Set StartTime and EndTime
It will run after 5 seconds and stop after 10 seconds in this example. The ruledat supports the above.
let startTime = Date + 5000;let endTime = startTime + 5000;var j = schedule;
Handle Jobs and Job Invocations
There are some function to get information for a Job and to handle the Job and Invocations.
You can invalidate any job with the
All planned invocations will be canceled. When you set the parameter reschedule to true then the Job is newly scheduled afterwards.
This method invalidates the next planned invocation or the job. When you set the parameter reschedule to true then the Job is newly scheduled afterwards.
This method cancels all pending invocation and registers the Job completely new again using the given specification. Return true/false on success/failure.
This method returns a Date object for the planned next Invocation for this Job. If no invocation is planned the method returns null.
We'd love to get your contributions. Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit.
Before jumping in, check out our Contributing page guide!
Copyright and license
Copyright 2015 Matt Patenaude.
Licensed under the [MIT License] license.