redux-automap
v1.3.1
Published
Redux helper library to greatly reduce action+reducer definition boilerplate.
Downloads
14
Maintainers
Readme
Redux helper library to greatly reduce action+reducer definition boilerplate.
Works with sagas, thunks, reselect, etc
Why?
Because much of the redux boilerplate (defining consts, logic in reducers to match actions to reducers, etc) really isn't necessary if you define actions with matching reducers together.
Usage
import { automap } from 'redux-automap'
const todos = automap({
initialState: [],
actionReducers: [
{
addTodo: text => ({ type: 'ADD_TODO', text }),
reducer: (state, action) => [ ...state, action.text ]
},
{
clearTodos: () => ({ type: 'CLEAR_TODOS' }),
reducer: state => []
}
]
})
/*
todos === {
actions: { // exposed for access to action creators
addTodo,
clearTodos
}
reducer: (state, action) // exposed as the main reducer for each branch
}
*/
const { addTodo, clearTodos } = todos.actions
const washClothesAction = addTodo('wash clothes') // { type: 'ADD_TODO', text: 'wash clothes' }
const foldClothesAction = addTodo('fold, clothes') // { type: 'ADD_TODO', text: 'fold clothes' }
let state = []
state = todos.reduce(state, washClothesAction) // state === [ 'wash clothes' ]
state = todos.reduce(state, foldClothesAction) // state === [ 'wash clothes', 'fold clothes' ]
state = todos.reduce(state, clearTodos()) // state === [ ]
Example (allows multiple actions routing through a shared reducer)
import { automap } from 'redux-automap'
const category = automap({
initialState: 'dogs',
actionReducers: [
{
setCategory: category => ({ type: 'SET_CATEGORY', category }),
setCategoryToBirds: () => ({ type: 'SET_CATEGORY', category: 'birds' }),
reducer: (state, action) => action.category // both actions will use this shared reducer
}
]
})
const { setCategory, setCategoryToBirds } = todos.actions
let state = 'dogs'
state = todos.reduce(state, setCategory('cats')) // state === 'cats'
state = todos.reduce(state, setCategoryToBirds()) // state === 'birds'
Changelog
v1.1.0 - added ability for multiple actions paired to one reducer v1.2.0 - added optional pass-through selector namespacing for use with combined reducers (docs to follow) v1.3.0 - actions and selectors are now automatically mapped onto default return (convenience)