GroupWork is an easy to use Swift framework that helps you orchestrate your concurrent, asynchronous functions in a clean and organized way. This helps make large functions with multiple asynchronous tasks more clear and easy to follow.
Contents
Requirements
Installation
CocoaPods
For CocoaPods, add to Podfile:
pod 'GroupWork', '~> 0.0'
Carthage
For Carthage, add to Cartfile:
github "quanvo87/GroupWork"
Swift Package Manager
For SPM, add to your package dependencies:
.package(url: "https://github.com/quanvo87/GroupWork.git", .upToNextMinor(from: "0.0.0"))
Manually
- for projects, drag
GroupWork.swiftto the project tree - for workspaces, include the whole
GroupWork.xcodeproj
Documentation
Example Usage
End Goal
import GroupWork
...
func complexFunc(completion: @escaping (Bool) -> Void) {
let work = GroupWork()
work.asyncFuncA()
work.asyncFuncB()
work.asyncFuncC()
work.allDone() {
completion(work.result)
}
}
...
complexFunc is a function that returns the result of three asynchronous functions asyncFuncA(), asyncFuncB(), and asyncFuncC(), running concurrently. The completion handler is called only when all these functions have completed. Usage of this library has enabled the above clean interface. This can be scaled to much higher than three asynchronous functions.
notes:
- the asynchronous functions should be able to run concurrently without affecting each other
work.resultis only a simpleBool- this is not an answer to callback hell
Set Up
There is some set up required in order to create complexFunc() from above:
import GroupWork
extension GroupWork {
func asyncFuncA() {
start()
networkCallA() { (result) in
self.finish(withResult: result)
}
}
func asyncFuncB() {
start()
networkCallB() { (result) in
self.finish(withResult: result)
}
}
func asyncFuncC() {
start()
networkCallC() { (result) in
self.finish(withResult: result)
}
}
}
Now you can create a GroupWork, and call work.simpleFuncA() on it like in the example.
notes:
start()must be called before an asynchronous taskfinish()must be called in the completion handler of an asynchronous taskstart()andfinish()calls must be balanced
Working Example
The tests have a working example.
License
Authors
- Quan Vo
- Wilson Ding
- Banner: Michelle Law
Please provide attribution, it is greatly appreciated.
4.6k Dec 27, 2022
23 Oct 14, 2022
4 Oct 15, 2022
7 Dec 28, 2022
8 Sep 18, 2022
36 Sep 26, 2022
1 Nov 30, 2021
7 Oct 2, 2022
1.2k Dec 27, 2022
2 Nov 29, 2022
684 Jan 9, 2023
26 Jan 1, 2023
367 Dec 24, 2022
2 Jun 15, 2021
752 Dec 5, 2022
60 Aug 11, 2022
48 Dec 4, 2022
18 Jun 17, 2022
31 Jul 1, 2019