mirror of
https://github.com/InsanusMokrassar/krontab.git
synced 2026-01-22 11:57:52 +00:00
fillup readme with asFlow info and add one more test
This commit is contained in:
26
README.md
26
README.md
@@ -11,6 +11,7 @@ runtime of applications.
|
||||
| [ How to use: Including in project ](#including-in-project) |
|
||||
| [ How to use: Config from string ](#config-from-string) |
|
||||
| [ 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
|
||||
|
||||
@@ -124,3 +125,28 @@ kronScheduler.doInfinity {
|
||||
```
|
||||
|
||||
All of these examples will do the same things: print `Called` message every five seconds.
|
||||
|
||||
### KronScheduler as a Flow
|
||||
|
||||
Any `KronScheduler`can e converted to a `Flow<DateTime` using extension `asFlow`:
|
||||
|
||||
```kotlin
|
||||
val kronScheduler = buildSchedule {
|
||||
seconds {
|
||||
0 every 1
|
||||
}
|
||||
}
|
||||
|
||||
val flow = kronScheduler.asFlow()
|
||||
```
|
||||
|
||||
So, in this case any operations related to flow are available and it is expected tt th will work correctly. For example,
|
||||
it is possible to use this flow with `takeWhile`:
|
||||
|
||||
```kotlin
|
||||
flow.takeWhile {
|
||||
condition()
|
||||
}.collect {
|
||||
action()
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user