InsanusMokrassar
/
krontab
mirror of https://github.com/InsanusMokrassar/krontab.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

update readme to include week days info

This commit is contained in:
InsanusMokrassar 2021-04-22 12:32:45 +06:00
parent 86cdda51a1
commit 20f12f3f2d
1 changed files with 20 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -14,6 +14,7 @@ runtime of applications.
| [ How to use: Config from string ](#config-from-string) | | [ How to use: Config from string ](#config-from-string) |
| [ How to use: Config via builder (DSL preview) ](#config-via-builder) | | [ How to use: Config via builder (DSL preview) ](#config-via-builder) |
| [ How to use: KronScheduler as a Flow ](#KronScheduler-as-a-Flow) | | [ How to use: KronScheduler as a Flow ](#KronScheduler-as-a-Flow) |
| [ Note about week days ](#Note-about-week-days) |
## How to use ## How to use
@ -52,14 +53,17 @@ For old version of Gradle, instead of `implementation` word developers must use
Developers can use more simple way to configure repeat times is string. String configuring Developers can use more simple way to configure repeat times is string. String configuring
like a `crontab`, but with a little bit different meanings: like a `crontab`, but with a little bit different meanings:
``` ```
/---------- Seconds /--------------- Seconds
| /-------- Minutes | /------------- Minutes
| | /------ Hours | | /----------- Hours
| | | /---- Days of months | | | /--------- Days of months
| | | | /-- Months | | | | /------- Months
| | | | | / (optional) Year | | | | | /----- (optional) Year
* * * * * * | | | | | | /--- (optional) Timezone offset
| | | | | | | / (optional) Week days
* * * * * * 0o *w
``` ```
It is different with original `crontab` syntax for the reason, that expected that in practice developers It is different with original `crontab` syntax for the reason, that expected that in practice developers
@ -152,3 +156,12 @@ flow.takeWhile {
action() action()
} }
``` ```
### Note about week days
Unlike original CRON, here week days:
* Works as `AND`: cron date time will search first day which will pass requirement according all parameters including
week days
* You may use any related to numbers syntax with week days: `0-3w`, `0,1,2,3w`, etc.
* Week days (like years and offsets) are optional and can be placed anywhere after `month`