cron-parser

Node.js library for parsing and manipulating crontab instructions. It includes support for timezones and DST transitions.

Compatibility
Node >= 12.0.0 TypeScript >= 4.2

Setup

1npm install cron-parser

Supported format

*    *    *    *    *    *
┬    ┬    ┬    ┬    ┬    ┬
│    │    │    │    │    |
│    │    │    │    │    └ day of week (0 - 7, 1L - 7L) (0 or 7 is Sun)
│    │    │    │    └───── month (1 - 12)
│    │    │    └────────── day of month (1 - 31, L)
│    │    └─────────────── hour (0 - 23)
│    └──────────────────── minute (0 - 59)
└───────────────────────── second (0 - 59, optional)

Supports mixed use of ranges and range increments (W character not supported currently). See tests for examples.

Usage

Simple expression.

1var parser = require('cron-parser');
2
3try {
4  var interval = parser.parseExpression('*/2 * * * *');
5
6  console.log('Date: ', interval.next().toString()); // Sat Dec 29 2012 00:42:00 GMT+0200 (EET)
7  console.log('Date: ', interval.next().toString()); // Sat Dec 29 2012 00:44:00 GMT+0200 (EET)
8
9  console.log('Date: ', interval.prev().toString()); // Sat Dec 29 2012 00:42:00 GMT+0200 (EET)
10  console.log('Date: ', interval.prev().toString()); // Sat Dec 29 2012 00:40:00 GMT+0200 (EET)
11} catch (err) {
12  console.log('Error: ' + err.message);
13}
14

Iteration with limited timespan. Also returns ES6 compatible iterator (when iterator flag is set to true).

1var parser = require('cron-parser');
2
3var options = {
4  currentDate: new Date('Wed, 26 Dec 2012 12:38:53 UTC'),
5  endDate: new Date('Wed, 26 Dec 2012 14:40:00 UTC'),
6  iterator: true
7};
8
9try {
10  var interval = parser.parseExpression('*/22 * * * *', options);
11
12  while (true) {
13    try {
14      var obj = interval.next();
15      console.log('value:', obj.value.toString(), 'done:', obj.done);
16    } catch (e) {
17      break;
18    }
19  }
20
21  // value: Wed Dec 26 2012 14:44:00 GMT+0200 (EET) done: false
22  // value: Wed Dec 26 2012 15:00:00 GMT+0200 (EET) done: false
23  // value: Wed Dec 26 2012 15:22:00 GMT+0200 (EET) done: false
24  // value: Wed Dec 26 2012 15:44:00 GMT+0200 (EET) done: false
25  // value: Wed Dec 26 2012 16:00:00 GMT+0200 (EET) done: false
26  // value: Wed Dec 26 2012 16:22:00 GMT+0200 (EET) done: true
27} catch (err) {
28  console.log('Error: ' + err.message);
29}
30

Timezone support

1var parser = require('cron-parser');
2
3var options = {
4  currentDate: '2016-03-27 00:00:01',
5  tz: 'Europe/Athens'
6};
7
8try {
9  var interval = parser.parseExpression('0 * * * *', options);
10
11  console.log('Date: ', interval.next().toString()); // Date:  Sun Mar 27 2016 01:00:00 GMT+0200
12  console.log('Date: ', interval.next().toString()); // Date:  Sun Mar 27 2016 02:00:00 GMT+0200
13  console.log('Date: ', interval.next().toString()); // Date:  Sun Mar 27 2016 04:00:00 GMT+0300 (Notice DST transition)
14} catch (err) {
15  console.log('Error: ' + err.message);
16}

Manipulation

1var parser = require('cron-parser');
2
3var interval = parser.parseExpression('0 7 * * 0-4');
4var fields = JSON.parse(JSON.stringify(interval.fields)); // Fields is immutable
5fields.hour = [8];
6fields.minute = [29];
7fields.dayOfWeek = [1,3,4,5,6,7];
8var modifiedInterval = parser.fieldsToExpression(fields);
9var cronString = modifiedInterval.stringify();
10console.log(cronString); // "29 8 * * 1,3-7"

Options

• currentDate - Start date of the iteration
• endDate - End date of the iteration

currentDate and endDate accept string, integer and Date as input.

In case of using string as input, not every string format accepted by the Date constructor will work correctly. The supported formats are:

• ISO8601
• HTTP and RFC2822
• SQL

The reason being that those are the formats accepted by the luxon library which is being used to handle dates.

Using Date as an input can be problematic specially when using the tz option. The issue being that, when creating a new Date object without any timezone information, it will be created in the timezone of the system that is running the code. This (most of times) won't be what the user will be expecting. Using one of the supported string formats will solve the issue(see timezone example).

• iterator - Return ES6 compatible iterator object
• utc - Enable UTC
• tz - Timezone string. It won't be used in case utc is enabled

Last weekday of the month

This library supports parsing the range 0L - 7L in the weekday position of the cron expression, where the L means "last occurrence of this weekday for the month in progress".

For example, the following expression will run on the last monday of the month at midnight:

0 0 0 * * 1L

The library also supports combining L expressions with other weekday expressions. For example, the following cron will run every Monday as well as the last Wednesday of the month:

0 0 0 * * 1,3L