-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathdoc.go
34 lines (26 loc) · 1.17 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/*
Package crong is a library for parsing cron expressions, calculating
the next run times of the expressions, and validating the expressions.
# Syntax
Supports standard cron syntax (see https://en.wikipedia.org/wiki/Cron),
as well as less standard expressions. For example, `5/10 4,5 * *` means
"every 10 minutes starting at the 5th minute of the hour, for hours 4 and 5."
Days of the week are indexed 0-6, with 0 being Sunday, and can be
referenced by name (SUN, MON, TUE, WED, THU, FRI, SAT) or by number.
Months are indexed 1-12, and can be referenced by
name (JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC) or by number.
Cron macros supported:
@yearly (or @annually) - Run once a year, midnight, Jan. 1
@monthly - Run once a month, midnight, first of month
@weekly - Run once a week, midnight between Saturday and Sunday
@daily (or @midnight) - Run once a day, midnight
@hourly - Run once an hour, beginning of hour
Other characters supported:
- - any value
, - value list separator
- - range of values
/ - step values
? - no specific value (month, day of month, day of week only)
L - last day of month (when used, must be used alone)
*/
package crong