natural-cron.js

Pure JS library for converting natural English phrases into Cron expressions.

!demo.gif

Usage

#### Browser

#### NodeJS
* Install package with...

npm install @darkeyedevelopers/natural-cron.js

* Import with require() & call getCronString() whenever required...

var getCronString = require('@darkeyedevelopers/natural-cron.js');

var cron = getCronString('every day at 2:55pm');

$3

Output result pattern can be specified while calling getCronString() function.

| Parameter | Type | Default value | Description |
| --- | --- | --- | --- |
| Input string    |    String    | | Required. English phrase that has to be
converted to corresponding Cron expression |
| Output pattern    |    String    | 'MIN HOR DOM MON WEK YER' | Optional. Specifies the output pattern in
which cron expression should be generated.

MIN => Minutes
HOR => Hours
DOM => Day of Month
MON => Month(s)
WEK => Weekday(s)
YER => Year

Combine one or more of the above to form
result pattern. Checkout the examples
below to understand better. |

$3

* _getCronString('every 3rd day at 2:55 am from January to August');_

=> 55 2 3 JAN-AUG ? *
* _getCronString('every 3rd day at 2:55 am from January to August', 'DOM MON YER');_

=> 3 JAN-AUG *
* _getCronString('every 3rd day at 2:55 am from January to August', 'DOM YER MON HOR');_

=> 3 * JAN-AUG 2
* _getCronString('every 3rd day at 2:55 am from January to August', '{DOM) some text MON :)');_

=> {3) some text JAN-AUG :)

Implemented using Push Down Automata

!design.png

*

Do you want to contribute ? Checkout CONTRIBUTING.md