redux-merging-reducers - npm Package Compare versions

Comparing version 0.0.1 to 0.0.2

package.json

 {
   "name": "redux-merging-reducers",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "A redux package to merge reducers",
@@ -5,0 +5,0 @@ "main": "build/index.js",

README.md

@@ -0,2 +1,92 @@
+[![Build Status](https://travis-ci.org/tejashjl1020/redux-merge-reducers.svg?branch=master)](https://travis-ci.org/tejashjl1020/redux-merge-reducers)
+![](https://img.shields.io/npm/v/redux-merging-reducers.svg)
+![](https://img.shields.io/david/tejashjl1020/redux-merge-reducers.svg)
+
 # redux-merge-reducers
-A redux package to merge reducers 
+
+A utility to merge multiple reducers into one.
+
+## Why?
+
+In the development of a large redux based web application, the reducers written for a particular state will grow simultaneously big. I noticed the importance of splitting the reducer, so each split can be more readable and reusable.
+
+
+This is not a alias for **combineReducer**
+
+`combineReducers` function merge reducers in a key-pair manner. Each reducer are independent to each other and do not share the state.
+
+Whereas `mergeReducers` function copies properties from all reducers to a single reducer. Each reducer can access the state of other reducers.
+
+## Installation
+
+```
+npm install --save redux-merging-reducers
+```
+
+## Examples
+#### 1. Main Reducer
+```es6
+const initialState = {
+  messages: []
+};
+
+export const MainReducer = (state = initialState, action) => {
+  switch (action.type) {
+    case 'ADD_MESSAGE':
+      return Object.assign({}, state, {
+        messages: state.messages.concat(action.payload.message)
+      });
+    default:
+      return state;
+  }
+};
+
+```
+
+#### 2. Extra Reducer.
+
+```es6
+const initialState = {
+  todos: []
+};
+
+export const ExtraReducer = (state = initialState, action) => {
+  switch (action.type) {
+    case 'ADD_TODO':
+      return Object.assign({}, state, {
+        todos: state.todos.concat(action.payload.todo)
+      });
+    default:
+      return state;
+  }
+};
+```
+#### 3. Merging Both Reducers
+
+```es6
+export const reducer = mergeReducers(MainReducer, ExtraReducer);
+```
+#### 4. Resulting redux state
+
+```es6
+{
+  messages: [],
+  todos: []
+}
+```
+
+## API
+
+redux-merging-reducers exports one function.
+
+### `mergeReducers(reducer1, reducer2, reducer...n)`
+
++ `reducer1`/`reducer2`/`reducerN` *(function)* **[required]** : a generic reducer function
+
+## License
+
+MIT
+
+## Author
+
+Tejash JL

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

161894

increased by1.32%

Number of package files

13

increased by8.33%

Number of lines in readme file

93

increased by3000%

No dependency changes