-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): Updated README with simple usage instructions
Closes #1
- Loading branch information
1 parent
8503ce9
commit 32a77f0
Showing
3 changed files
with
31 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,44 @@ | ||
# cronmatch | ||
|
||
`cronmatch` is a simple cron expression parser. It compares a provided date string or `Date` object with a cron expression to see if it matches. | ||
`Cronmatch` is a simple cron expression parser. It compares a provided date string or `Date` object with a cron expression to see if it matches. | ||
|
||
## Installation | ||
|
||
For use in Node: | ||
``` | ||
npm install cronmatch | ||
npm install @paulsmith/cronmatch | ||
``` | ||
|
||
For use in the browser: | ||
``` | ||
<script src="https://unpkg.com/@paulsmith/cronmatch/dist/cronmatch.min.js"></script> | ||
``` | ||
|
||
## Usage | ||
## Usage | ||
|
||
``` | ||
const cronmatch = require('cronmatch'); | ||
var cronExpr = '*/2 * * * *'; // Every even minute | ||
var date1 = new Date('January 20, 2020 12:00:00'); | ||
var date2 = new Date('January 20, 2020 12:01:00'); | ||
cronmatch(cronExpr, date1); // true | ||
cronmatch(cronExpr, date2); // false | ||
``` | ||
|
||
minute: [0, 59] | ||
hour: [0, 23] | ||
day: [1, 31] | ||
month: [1, 12] | ||
dayOfWeek: [0, 6] | ||
|
||
|
||
|
||
## Limitations | ||
|
||
* `cronmatch` does not yet understand 6-field cron expressions with seconds | ||
* It does not yet validate cron expressions | ||
* Does not yet support JAN-DEC for month or MON-SUN for dayOfWeek |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters