diff --git a/docs/krontab/introduction/faq.md b/docs/krontab/introduction/faq.md index 6554f73..7b55720 100644 --- a/docs/krontab/introduction/faq.md +++ b/docs/krontab/introduction/faq.md @@ -2,7 +2,7 @@ #### How oftern new versions are releasing? -Not very often. It depend on libraries (coroutines, korlibs/klock) updates and on some new awesome, but lightweight, features coming. +Not very often. It depends on libraries (coroutines, korlibs/klock) updates and on some new awesome, but lightweight, features coming. #### Where this library could be useful? @@ -16,4 +16,4 @@ In two words, you should call `buildSchedule` or `createSimpleScheduler`: buildSchedule("5 * * * *").asFlow().collect { /* do something */ } ``` -You can read more about syntax in [String format](../describing/string-format.md) section. \ No newline at end of file +You can read more about syntax in [String format](../describing/string-format.md) section. diff --git a/docs/krontab/introduction/how-to-use.md b/docs/krontab/introduction/how-to-use.md index 4774928..54efa4d 100644 --- a/docs/krontab/introduction/how-to-use.md +++ b/docs/krontab/introduction/how-to-use.md @@ -7,7 +7,8 @@ ## `buildSchedule` > NOTE: **Custom KronScheduler** -> You always able to create your own scheduler. In this section will be presented different ways and examples around standard `CronDateTimeScheduler` builders `buildSchedule`. You can read about schedulers in [KrontabScheduler](../describing/krontabscheduler.md) +> +> You are always may create your own scheduler. In this section will be presented different ways and examples around standard `CronDateTimeScheduler` builders `buildSchedule`. You can read about schedulers in [KrontabScheduler](../describing/krontabscheduler.md) Currently, `buildSchedule` is the recommended start point for every scheduler. Usually, it is look like: @@ -45,13 +46,14 @@ Shortcuts are the constants that are initializing in a lazy way to provide prese * `AnyTimeScheduler` - will always return incoming `DateTime` as next * `Every*Scheduler` - return near * since the passed `relatively`: - * `EverySecondScheduler` - * `EveryMinuteScheduler` - * `EveryHourScheduler` - * `EveryDayOfMonthScheduler` - * `EveryMonthScheduler` - * `EveryYearScheduler` + * `EverySecondScheduler` / `KronScheduler.everyMillisecond` + * `EverySecondScheduler` / `KronScheduler.everySecond` + * `EveryMinuteScheduler` / `KronScheduler.everyMinute` + * `EveryHourScheduler` / `KronScheduler.hourly` + * `EveryDayOfMonthScheduler` / `KronScheduler.daily` + * `EveryMonthScheduler` / `KronScheduler.monthly` + * `EveryYearScheduler` / `KronScheduler.annually` ### Flows -Here currently there is only one extension for `KronScheduler`: `KronScheduler#asFlow`. As a result you will get `Flow` (in fact `SchedulerFlow`) which will trigger next `emit` on each not null `next` `DateTime` \ No newline at end of file +Here currently there is only one extension for `KronScheduler`: `KronScheduler#asFlow`. As a result you will get `Flow` (in fact `SchedulerFlow`) which will trigger next `emit` on each not null `next` `DateTime`