cron-time v1.1.1

CronTime

Parse cron time string

Parameters

• pattern string pattern
• options object? initial options
  • options.start (date | number | string)? start
  • options.end (date | number | string)? end
  • options.zone string zone (optional, default '+00')

Examples

import CronTime from 'cron-time';
let i = new CronTime('0-1,4 0 0 * * *', {
	start: '1970-01-01 00:00:00.0=John Doe00Z',
	end: '1970-01-01 23:59:59.000Z'
});

const next = i.next()
// 1970-01-01T00:00:00.000Z;

const portion = i.nextPortion(2);
// [ '1970-01-01T00:00:01.000Z', '1970-01-01T00:00:04.000Z'] ;

pattern

String that represents period in cron format

Examples

*  *  *  *  *  *
┬  ┬  ┬  ┬  ┬  ┬
│  │  │  │  │  └─────────────── day of week (0 - 7) (0 and 7 - represents Sunday)
│  │  │  │  └────────────────── month (1 - 12)
│  │  │  └───────────────────── day of month (1 - 31)
│  │  └──────────────────────── hour (0 - 23)
│  └─────────────────────────── minute (0 - 59)
└────────────────────────────── second (0 - 59)

* * * * * * - every second
0 * * * * * - every minute
0 0 * * * * - every hour
0 0 0 * * * - every day
0 0 0 * * 1 - every monday
0 1-2 * * * - every first and second minutes of hour
0 0 1,2 * * - every first and second hours of day
0 0 0-12/2 * * - every second hour of day first half

also you can use synonyms:
* @yearly   - 0 0 0 1 1 *
* @annually - 0 0 0 1 1 *
* @monthly  - 0 0 0 1 * *
* @weekly   - 0 0 0 * * 0
* @daily    - 0 0 0 * * *
* @hourly   - 0 0 * * * *

zone

Parameters

• value string zone in rfc2822 format

start

Start value for searching matches to pattern values

Parameters

• value (date | number | string) any convertible to {@link Date) value

Examples

import CronTime from 'cron-time';
let i = new CronTime('0-1,4 0 0 * * *');
i.start = '1970-01-01 00:00:00.000Z';
console.log(i.start); // '1970-01-01 00:00:00.000Z';
i.rewind();

end

Final value for searching matches to pattern values

Parameters

• value (date | number | string) any convertible to {@link Date) value

Examples

import CronTime from 'cron-time';
let i = new CronTime('0-1,4 0 0 * * *');
i.end = '1970-12-31 00:00:00.000Z';
console.log(i.end); // '1970-12-31 00:00:00.000Z';
i.rewind();

rewind

Rewinds current matching position to start

Examples

import CronTime from 'cron-time';
let i = new CronTime('0-1,4 0 0 * * *');
i.start = '1970-01-01 00:00:00.000Z';
i.rewind();
i.next(); // '1970-01-01 00:00:00.000Z';
i.next(); // '1970-01-01 00:00:01.000Z';
i.rewind();
i.next(); // '1970-01-01 00:00:00.000Z';

position

Examples

import CronTime from 'cron-time';
let i = new CronTime('0-1,4 0 0 * * *');
i.start = '1970-01-01 00:00:00.000Z';
i.rewind();
i.next();
i.next();
i.position; // '1970-01-01 00:00:01.000Z';

Returns (Date | undefined) current matching to pattern time

next

Returns (Date | undefined) next matching to the pattern value

nextPortion

Parameters

• size Number? size of data portion (optional, default 1)

Returns Array.date next values that match to the pattern

toString

Returns String string representation of cron period pattern

Installation

npm install --save crontime