Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/BrettRToomey/Jobs
A job system for Swift backends.
https://github.com/BrettRToomey/Jobs
Last synced: 3 months ago
JSON representation
A job system for Swift backends.
- Host: GitHub
- URL: https://github.com/BrettRToomey/Jobs
- Owner: BrettRToomey
- License: mit
- Created: 2016-11-07T20:14:53.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-19T18:33:19.000Z (over 4 years ago)
- Last Synced: 2024-04-22T04:15:56.443Z (7 months ago)
- Language: Swift
- Size: 67.4 KB
- Stars: 293
- Watchers: 9
- Forks: 21
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ios - Jobs - A job system for Swift backends. (Server / Keychain)
- awesome-ios-star - Jobs - A job system for Swift backends. (Server / Keychain)
README
# Jobs
[](http://swift.org) 
[](https://codecov.io/gh/BrettRToomey/Jobs)
[](https://codebeat.co/projects/github-com-brettrtoomey-jobs)
[](https://raw.githubusercontent.com/BrettRToomey/Jobs/master/LICENSE.md)
A minimalistic job system in Swift, for Swift
##### Table of Contents
* [Getting started](#getting-started-)
* [Intervals](#intervals-)
* [Syntax candy](#syntax-candy-)
* [Starting a job](#starting-a-job-)
* [Stopping a job](#stopping-a-job-)
* [Error handling](#error-handling-)
* [Retry on failure](#retry-on-failure-)
## Integration
Update your `Package.swift` file.
```swift
.package(url: "https://github.com/BrettRToomey/Jobs.git", from: "1.1.1")
```
## Getting started 🚀
Creating a new `Job` is as simple as:
```swift
Jobs.add(interval: .seconds(4)) {
print("👋 I'm printed every 4 seconds!")
}
```
## Intervals ⏲
The `Duration` enumeration currently supports `.seconds`, `hours`, `.days` and `.weeks`.
```swift
Jobs.add(interval: .days(5)) {
print("See you every 5 days.")
}
```
#### Syntax candy 🍭
It's possible to create a `Duration` from an `Int` and a `Double`.
```swift
10.seconds // `Duration.seconds(10)`
4.hours // `Duration.hours(4)`
2.days // `Duration.days(2)`
3.weeks // `Duration.weeks(3)`
```
## Starting a job 🎬
By default, `Job`s are started automatically, but if you wish to start one yourself, even at a later point in time, just do the following:
```swift
let job = Jobs.add(interval: 2.seconds, autoStart: false) {
print("I wasn't started right away.")
}
//...
job.start()
```
## Stopping a job ✋
Giving up has never been so easy!
```swift
job.stop()
```
## One-off jobs
If you just want to asynchronously run a job, but not repeat it you can use the `oneoff` functions.
```swift
Jobs.oneoff {
print("Sadly, I'm not a phoenix.")
}
```
How about waiting a little?
```swift
Jobs.oneoff(delay: 10.seconds) {
print("I was delayed by 10 seconds.")
}
```
## Error handling ❌
Sometimes jobs can fail, that's okay, we have you covered.
```swift
Jobs.add(
interval: 10.seconds,
action: {
throw Error.someError
},
onError: { error in
print("caught an error: \(error)")
return RecoverStrategy.default
}
)
```
#### Retry on failure ⭕️
By default, jobs will be attempted again after a five second delay. If you wish to override this behavior you must first implement an `onError` handler and return one of the following `RecoveryStrategy` cases.
```swift
.none //do not retry
.default //retry after 5 seconds
.retry(after: Duration) //retry after specified duration
```
Here's a small sample:
```swift
enum Error: Swift.Error {
case recoverable
case abort
}
Jobs.add(
interval: 1.days,
action: {
//...
},
onError: { error in
switch error {
//we cannot recover from this
case .abort:
//do not retry
return .none
//we can recover from this
case .recoverable:
//... recovery code
//try again in 15 seconds
return .retry(after: 15.seconds)
}
}
)
```