Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reswift/reswift-thunk
Thunk middleware for ReSwift.
https://github.com/reswift/reswift-thunk
redux reswift swift thunk
Last synced: 25 days ago
JSON representation
Thunk middleware for ReSwift.
- Host: GitHub
- URL: https://github.com/reswift/reswift-thunk
- Owner: ReSwift
- License: mit
- Created: 2018-10-25T15:25:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-26T20:08:14.000Z (over 3 years ago)
- Last Synced: 2024-12-05T18:51:18.824Z (about 1 month ago)
- Topics: redux, reswift, swift, thunk
- Language: Swift
- Homepage:
- Size: 743 KB
- Stars: 106
- Watchers: 12
- Forks: 29
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ReSwift-Thunk
[](https://travis-ci.org/ReSwift/ReSwift-Thunk)
[](http://codecov.io/github/ReSwift/ReSwift-Thunk)
[](https://cocoapods.org/pods/ReSwiftThunk)
[](https://github.com/ReSwift/ReSwift-Thunk/blob/master/LICENSE.md)
[](https://github.com/ReSwift/ReSwift-Thunk/blob/master/LICENSE.md) [](https://houndci.com)
**Supported Swift Versions:** Swift 4.2, Swift 5.0, Swift 5.3
When [ReSwift](https://github.com/ReSwift/ReSwift/) is a [Redux](https://github.com/reactjs/redux)-like implementation of the unidirectional data flow architecture in Swift, ReSwift-Thunk is like [redux-thunk](https://github.com/reduxjs/redux-thunk).
## Why Use ReSwift-Thunk?
## Example
```swift
// First, you create the middleware, which needs to know the type of your `State`.
let thunkMiddleware: Middleware = createThunkMiddleware()
// Note that it can perfectly live with other middleware in the chain.
let store = Store(reducer: reducer, state: nil, middleware: [thunkMiddleware])
// A thunk represents an action that can perform side effects, access the current state of the store, and dispatch new actions, as if it were a ReSwift middleware.
let thunk = Thunk { dispatch, getState in
if getState!.loading {
return
}
dispatch(RequestStart())
api.getSomething() { something in
if something != nil {
dispatch(RequestSuccess(something))
} else {
dispatch(RequestError())
}
}
}
// A thunk can also be a function if you want to pass on parameters
func thunkWithParams(_ identifier: Int) -> Thunk {
return Thunk { dispatch, getState in
guard let state = getState() else { return }
if state.loading {
return
}
api.getSomethingWithId(identifier) { something in
if something != nil {
dispatch(RequestSuccess(something))
} else {
dispatch(RequestError())
}
}
}
}
// As the thunk type conforms to the `Action` protocol, you can dispatch it as usual, without having to implement an overload of the `dispatch` function inside the ReSwift library.
store.dispatch(thunk)
// You can do the same with the Thunk that requires parameters, like so
store.dispatch(thunkWithParams(10))
// Note that these actions won't reach the reducers, instead, the thunks middleware will catch it and execute its body, producing the desired side effects.
```
## Testing
The `ExpectThunk` helper, available as a CocoaPods subspec, allows for testing the order and actions of `dispatch` as well as the
dependencies on `getState`.
```swift
ExpectThunk(thunk)
.getsState(RequestState(loading: false))
// If the action is Equatable it will be asserted for equality with `dispatches`.
.dispatches(RequestStart())
.dispatches { action in
XCTAssert(action.something == expectedSomething)
}
.wait() // or simply run() for synchronous flows
```
## Installation
ReSwift-Thunk requires the [ReSwift](https://github.com/ReSwift/ReSwift/) base module.
### CocoaPods
You can install ReSwift-Thunk via CocoaPods by adding it to your `Podfile`:
```
target 'TARGET' do
pod 'ReSwiftThunk'
end
target 'TARGET-TESTS' do
pod 'ReSwiftThunk/ExpectThunk'
end
```
And run `pod install`.
#### A Note on Including ExpectThunk
If the `ExpectThunk` subspec is used, the tests target cannot be nested in another target due to current limitations. The tests target must
be a standalone target as shown in the snippet above.
### Carthage
You can install ReSwift-Thunk via [Carthage](https://github.com/Carthage/Carthage) by adding the following line to your `Cartfile`:
```
github "ReSwift/ReSwift-Thunk"
```
### Swift Package Manager
You can install ReSwift-Thunk via [Swift Package Manager](https://swift.org/package-manager/) by adding the following line to your `Package.swift`:
```swift
import PackageDescription
let package = Package(
[...]
dependencies: [
.Package(url: "https://github.com/ReSwift/ReSwift-Thunk.git", majorVersion: XYZ)
]
)
```
Import testing support by importing `ReSwiftThunkTesting`
```swift
import ReSwiftThunkTesting
```
## Checking out Source Code
After checking out the project run `pod install` to get the latest supported version of [SwiftLint](https://github.com/realm/SwiftLint), which we use to ensure a consistent style in the codebase.
## Example Projects
- [ReduxMovieDB](https://github.com/cardoso/ReduxMovieDB): A simple App that queries the tmdb.org API to display the latest movies. Allows searching and viewing details. [Relevant file](https://github.com/cardoso/ReduxMovieDB/blob/master/ReduxMovieDB/Thunks.swift).
## Contributing
You can find all the details on how to get started in the [Contributing Guide](/CONTRIBUTING.md).
## Credits
## License
ReSwift-Thunk Copyright (c) 2018 ReSwift Contributors. Distributed under the MIT License (MIT). See [LICENSE.md](/CONTRIBUTING.md).