[](https://travis-ci.org/liebsoer/redux-structure-factory)
# redux-structure-factory
Factory module to create a redux structure
# Installation
TBD
# Usage
## Container configuration
**Configuration object**
```javascript
{
'label': 'Some Name',
'defaultState': {},
'actions': {
'ACTION_KEY': {
'actionName': 'An action',
'actionCreator': function(...payload){ ... },
'reducerAction': function(state, action) { ... }
}
},
'filter': {
'filterName': function(...filterArgs){ ... }
}
}
```
**Description**
| Field Name | Type | Description |
| - | - | - |
| label | string | Redux container label. If not existing, registered name will be used.
_Mandatory_: false
| | defaultState | object |Default state. If no default state is defined an empty object will be used.
_Mandatory_: false
| | actions | object |Holds all actions with it's respective action creator function and reducer function
*Mandatory*: true
| | ACTION_KEY | object |Name of the action. It will be automatically converted to `camelCase` and used as the function name.
Must be `UPPER_CASE [A_Z_]`. Otherwise it will be ignored!
_Mandatory_: true
| | actionName | string |Descriptive text of the action.
_Mandatory_: true | | actionCreator | function |
Creates a valid action for processing the calculation of the new state. Only pure JSON (see also http://json.org/) values are allowed. Other value types will be stringified with _`JSON.stringify()`_ and if that returns _`undefined`_ the function _`toString()`_ is tried to be called. If this also returns _`undefined`_ the payload parameter will be ignored. Also parameter with value _`undefined`_ are ignored.
If the field is missing an simple object with just the _`type`_ and an empty _`payload`_ object will be created.
_Mandatory_: false
`@param` _**...payload**_ _(optional)_ One ore more arguments to store inside the payload for calculating the new state.
`@return` Object with fields _`type`_ which is the same as _`ACTION_NAME`_ and _`payload`_ where the calculated payload is stored into.
Calculates the new partial state the container is responsible for. If no return value is present for the reducer, the factory takes care of returning the original state.
_Mandatory_: true
`@param` _**state**_ A copy of the old state. The factory takes care of passing a copy of the old state. So the second Redux principle isn't violated. The state can safely be altered.
`@param` _**action**_ Object with fields _`type`_ which is the same as _`ACTION_NAME`_ and _`payload`_ where the payload is stored into.
`@return` The new state
Contains functions to filter the state.
_Mandatory_: false
| | filterName | function |Filters the state and returns only the information wanted.
_Mandatory_: false
`@param` _**...filterArgs**_ (optional) One or more arguments to narrow the filter result
`@return` Filtered value or null if no matching value can be found