https://github.com/platzidev/redux-duck
Helper function to create Redux modules using the ducks-modular-redux proposal
https://github.com/platzidev/redux-duck
Last synced: 9 months ago
JSON representation
Helper function to create Redux modules using the ducks-modular-redux proposal
- Host: GitHub
- URL: https://github.com/platzidev/redux-duck
- Owner: PlatziDev
- License: mit
- Created: 2016-04-19T20:20:39.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2019-09-12T10:48:07.000Z (almost 7 years ago)
- Last Synced: 2025-03-22T17:11:29.428Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 90
- Watchers: 4
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# redux-duck
Helper function to create Redux modules using the [ducks-modular-redux](https://github.com/erikras/ducks-modular-redux/) proposal.
## Installation
```bash
npm i -S redux-duck
```
## API
### Create duck
```javascript
import { createDuck } from 'redux-duck';
const myDuck = createDuck('duck-name', 'application-name');
```
* `createDuck` receive 2 arguments, the second argument is optional.
* The first argument is the duck name.
* The second, and optional, argument is the application or module name.
### Define action types
```javascript
const ACTION_TYPE = myDuck.defineType('ACTION_TYPE');
```
* `defineType` receive just one argument.
* The argument is the name of the action.
* The result should be an string like `application-name/duck-name/ACTION_TYPE` or `duck-name/ACTION_TYPE` if the application or module name was not defined.
### Create action creators
```javascript
const actionType = myDuck.createAction(ACTION_TYPE);
```
* `createAction` receive just one argument.
* This argument should be the defined action type string.
* It should return a function who will receive the action payload and return a valid (FSA compilant) action object.
* The action creator will receive an optional argument with the action payload.
### Create reducer
```javascript
const initialState = {
list: Immutable.List(),
data: Immutable.Map(),
};
const reducer = myDuck.createReducer({
[ACTION_TYPE]: (state, action) => ({
...state,
list: state.list.push(action.payload.id),
data: state.map.set(action.payload.id+'', action.payload),
}),
}, initialState);
```
* `createReducer` receive two arguments, both required.
* The first argument is an object with the possible action cases.
* The second argument is the reducer initial state.
* The first argument should use the previously defined *action types* as keys.
* Each key in the first argument object should be a function who will receive the current state and the dispatched action as arguments and return the updated state.