README
¶
gredux
gredux is a golang implementation of a redux-esque state container. The aim is to provide a structure for writing applications which have consistent, predictable behaviour.
Example Usage
import (
"github.com/avahowell/gredux"
)
// Create an initial state for the Store
type counterState struct {
count int
}
// Instantiate a new store around this state
store := gredux.New(counterState{0})
// Create a reducer which increments "count" when it receives an "increment"
// action, and decrements when it receives a "decrement" action.
store.AddReducer(func(state gredux.State, action gredux.Action) gredux.State {
switch action.ID {
case "increment":
return counterState{state.(counterState).count + action.Data.(int)}
case "decrement":
return counterState{state.(counterState).count - action.Data.(int)}
default:
return state
}
})
store.Dispatch(Action{"increment", 5})
store.Dispatch(Action{"decrement", 2})
fmt.Println(store.State().(counterState).count) // prints 3
// Register a func to be called after each state update
store.AfterUpdate(func(state State) {
fmt.Println(state.(counterState).count) // prints the count after every state update
})
// Register a hook for given action that will be invoked everytime that action is dispatched
// This hook must not dispatch another action otherwise deadlock will happen!
store.AddHook(func(state State) {
fmt.Println(state.(counterState).count) // prints the count after every state update
}, []string{"increment"})
store.Dispatch(Action{"decrement", 2})
License
The MIT License (MIT)
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Action ¶
type Action struct {
ID string
Data interface{}
}
Action defines a dispatchable data type that triggers updates in the Store.
type Reducer ¶
Reducer is the func which receives actions dispatched using Store.Dispatch() and updates the internal state.
type Store ¶
type Store struct {
// contains filtered or unexported fields
}
Store defines an immutable store of state. The current state of the Store can be received by calling State() but the state can only be changed by a Reducer as the result of a Dispatch'd Action.
func New ¶
New instantiates a new gredux Store. initialState should be the struct used to define the Store's state.
func (*Store) AddHook ¶
AddHook adds a hook which is invoked for specific actions that are specified as second argument The hook must not dispatch another actions otherwise deadlock will happen!
func (*Store) AddReducer ¶
AddReducer sets the store's reducers function to the function `r`.
func (*Store) AfterUpdate ¶
AfterUpdate sets Store's update func. `update` is called after each dispatch with a copy of the new state.
Source Files