Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/galassie/redux-fsharp
⚛️ Predictable state container for F# apps
https://github.com/galassie/redux-fsharp
fsharp redux redux-fsharp
Last synced: about 2 months ago
JSON representation
⚛️ Predictable state container for F# apps
- Host: GitHub
- URL: https://github.com/galassie/redux-fsharp
- Owner: galassie
- License: mit
- Created: 2019-11-09T23:50:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2022-11-24T09:00:21.000Z (about 2 years ago)
- Last Synced: 2024-07-30T18:33:08.322Z (5 months ago)
- Topics: fsharp, redux, redux-fsharp
- Language: F#
- Homepage:
- Size: 58.6 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# redux-fsharp
[](https://ci.appveyor.com/project/galassie/redux-fsharp) [](https://nuget.org/packages/redux-fsharp)
Predictable state container for F# applications.
redux-fsharp is a [Redux](https://github.com/reduxjs/redux)-like implementation of the unidirectional data flow architecture in F#.
## Add package
If you want to add this package to your project, execute the following command:
``` shell
dotnet add package redux-fsharp
```
## Build on your machine
If you want to build this library on your machine, execute the following commands:
``` shell
git clone https://github.com/galassie/redux-fsharp.git
cd redux-fsharp
dotnet build
```
If you want to run the tests, execute the following command:
``` shell
dotnet test
```
## Build in Docker
Required:
- Install [Docker](https://hub.docker.com/search/?type=edition&offering=community) for your system
Build a Docker image called `redux-fsharp`. This will work without any local .NET Core installation.
```shell
docker build -t redux-fsharp .
```
Use the following to instantiate a Docker container from the `redux-fsharp` image and run the tests inside:
```shell
docker run --rm redux-fsharp dotnet test
```
## Usage
### State:
``` fsharp
type State = { CurrentValue: int }
```
### Actions:
``` fsharp
type IncrementAction = { Amount: int }
type DecrementAction = { Amount: int }
type Actions =
| Increment of IncrementAction
| Decrement of DecrementAction
```
### Reducer:
``` fsharp
let incrementDecrementReducer state action =
match action with
| Increment { Amount = amount } -> { state with CurrentValue = state.CurrentValue + amount }
| Decrement { Amount = amount } -> { state with CurrentValue = state.CurrentValue - amount }
```
### Subscriber:
``` fsharp
let consoleLogSubscriber state =
printfn "Current value: %d" state.CurrentValue
```
### Program:
``` fsharp
[]
let main argv =
let store = createStore incrementDecrementReducer { CurrentValue = 0 } id
let unsubscribe = store.Subscribe(consoleLogSubscriber)
store.Dispatch (Increment { Amount = 1 }) |> ignore
store.Dispatch (Increment { Amount = 2 }) |> ignore
store.Dispatch (Decrement { Amount = 1 }) |> ignore
unsubscribe() |> ignore
store.Dispatch (Decrement { Amount = 1 }) |> ignore
let lastState = store.GetState()
printfn "Expected Current value should be 1"
printfn "Actual Current value is %d" lastState.CurrentValue
0 // return an integer exit code
```
## Examples
- [Simple Store](https://github.com/galassie/redux-fsharp/tree/master/examples/Redux.FSharp.SimpleStore)
- [Combine Reducers](https://github.com/galassie/redux-fsharp/tree/master/examples/Redux.FSharp.CombineReducers)
- [Apply Middleware](https://github.com/galassie/redux-fsharp/tree/master/examples/Redux.FSharp.ApplyMiddleware)
## Contributing
Code contributions are more than welcome! 😻
Please commit any pull requests against the `master` branch.
If you find any issue, please [report it](https://github.com/galassie/redux-fsharp/issues)!
## License
This project is licensed under [The MIT License (MIT)](https://raw.githubusercontent.com/galassie/redux-fsharp/master/LICENSE.md).
Author: [Enrico Galassi](https://twitter.com/enricogalassi88)