redux-store-cleaner - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "redux-store-cleaner",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Reset store branch with simple action",
@@ -5,0 +5,0 @@ "main": "./lib/index.js",

README.md

@@ -7,16 +7,36 @@ # redux-state-cleaner
 
+# Installation
+```
+npm i redux-store-cleaner -S
+```
+
+# Features
+
+* Reset store branches by sending 'undefined' in its reducers
+* Clean specific reducer with namespace
+
 # Usage
 
-TODO
+Wrap your reducer with `withStoreCleaner` function
+```javascript
+import withStoreCleaner from 'redux-store-cleaner';
 
-# Features
+const someFancyReducer = (state, action) => { /* Impl */ };
 
-TODO
+export default withStoreCleaner(someFancyReducer, 'someFancyReducerNamespace');
+```
 
-# Installation
-TODO
+and call cleanStore wherever you want
 
+```javascript
+import { cleanStore } from 'redux-store-cleaner';
+import { store } from './store';
 
+store.dispatch(cleanStore('someFancyReducerNamespace'));
+// You can also clean all stores with omitting namespace
+// store.dispatch(cleanStore('));
+```
+
 # License
 
 MIT © Andrew Paramoshkin

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

6127

increased by12.4%

Number of lines in readme file

42

increased by90.91%

No dependency changes