redux-session - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

dist/index.js

@@ -40,3 +40,3 @@ 'use strict';
 function shallowOmit (keys, obj) {
-  var j = {}, k;
+  var j = {};
   for (var k$1 in obj) {
@@ -239,3 +239,3 @@ if (keys.indexOf(k$1) === -1) {
       // dispatch the action
-      next(action);
+      var result = next(action);
 
@@ -246,6 +246,8 @@ // flag for whether storage should be cleared.
       // clear storage if needed
-      if (shouldClearStorage) storage.clear(ns, _opts);
+      if (shouldClearStorage) { storage.clear(ns, _opts); }
 
       // otherwise, update storage with the latest
-      else updateStorage();
+      else { updateStorage(); }
+
+      return result;
     }; }
@@ -256,2 +258,2 @@ }
 exports.adapters = adapters;
-exports.createSession = createSession;
+exports.createSession = createSession;

package.json

 {
   "name": "redux-session",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Automatically cache parts (or all) of your state in localStorage, sessionStorage or cookies.",
@@ -20,3 +20,3 @@ "main": "dist/index.js",
     "type": "git",
-    "url": "git+https://github.com/helpfulhuman/redux-session.git"
+    "url": "git+https://github.com/samuelsantia/redux-session.git"
   },
@@ -39,12 +39,12 @@ "keywords": [
   "devDependencies": {
-    "buble": "^0.12.5",
     "chai": "^3.5.0",
     "mocha": "^2.5.3",
     "mock-local-storage": "^1.0.2",
-    "rollup": "^0.34.1",
-    "rollup-plugin-buble": "^0.12.1",
-    "rollup-watch": "^2.5.0",
+    "rollup": "^0.50.0",
+    "rollup-plugin-buble": "^0.16.0",
+    "rollup-watch": "^4.3.1",
     "sinon": "^1.17.5",
     "sinon-chai": "^2.8.0"
-  }
+  },
+  "dependencies": {}
 }

README.md

@@ -118,5 +118,39 @@ # Redux Session Middleware
 
+## Debouncing
+A custom debouncing method can be passed in via the opts if you want to override the default method. This function wraps around the call to update the session storage and prevents it from being updated too many times in the same interval. The default function will simply return if the update was called within the designated interval, however a custom function can be used if any other actions need to take place during the debounce method.
+
+```js
+function myDebouncer(fn, wait) {
+  console.log("this is my custom debouncer");
+  // do some custom stuff!
+  let timeout, dirty;
+
+  return function () {
+    if (timeout) {
+      dirty = true;
+      return;
+    }
+
+    timeout = setTimeout(function () {
+      clearTimeout(timeout);
+      timeout = null;
+      if (dirty) {
+        fn.apply(this, arguments);
+        dirty = false;
+      }
+    }, wait);
+
+    fn.apply(this, arguments);
+  }
+}
+
+const session = createSession({
+  ns: 'myproject',
+  debounce: myDebouncer
+});
+```
+
 ## Clearing Stored State
 
-Finally, if you want to clear your stored session data completely, you can dispatch an action your store with the type of `CLEARED_STORED_STATE`.  The session middleware will watch for this action to invoke the adapter's `clear()` method.  You can optionally specify a custom `clearStorage` function to spy on actions and determine if the stored state should be dropped.
+Finally, if you want to clear your stored session data completely, you can dispatch an action your store with the type of `CLEAR_STORED_STATE`.  The session middleware will watch for this action to invoke the adapter's `clear()` method.  You can optionally specify a custom `clearStorage` function to spy on actions and determine if the stored state should be dropped.
 
@@ -123,0 +157,0 @@ ```js

rollup.config.js

 import buble from 'rollup-plugin-buble';
 
 export default {
-  entry: 'src/index.js',
-  format: 'cjs',
+  input: 'src/index.js',
+  output: {
+    file: 'dist/index.js',
+    format: 'cjs',
+  },
+  exports: 'named',
   plugins: [ buble() ],
-  dest: 'dist/index.js'
 };

src/adapters/cookieStorage.js

@@ -0,0 +0,0 @@ function notImplementedWarning () {

src/adapters/localStorage.js

@@ -0,0 +0,0 @@ export default {

src/index.js

@@ -93,3 +93,3 @@ import { getAdapter, debounce, shallowOmit } from './utils';
       // dispatch the action
-      next(action);
+      const result = next(action);
 
@@ -104,4 +104,6 @@ // flag for whether storage should be cleared.
       else updateStorage();
+
+      return result;
     }
   }
 }

src/utils.js

@@ -0,0 +0,0 @@ /**

test/createSession.js

@@ -203,2 +203,12 @@ const chai = require('chai');
 
+  it('the created middleware chains the passed action', function () {
+    const action = { type: 'TEST' };
+    const session = createSession({ ns, adapter: testAdapter });
+    testStore.dispatch.withArgs(action).returns(action);
+
+    const result = session(testStore)(testStore.dispatch)(action);
+
+    expect(testStore.dispatch).to.have.been.calledWith(action);
+    expect(result).to.be.equal(action);
+  });
 });

test/localStorage.js

@@ -0,0 +0,0 @@ global.window = {};

test/utils.js

@@ -0,0 +0,0 @@ const { stub } = require('sinon');

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

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

34342

increased by7.83%

Dev dependency count

8

decreased by-11.11%

Lines of code

676

increased by2.11%

Number of lines in readme file

164

increased by26.15%

Worsened metrics

Number of package files

14

decreased by-6.67%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes