@rooks/use-sessionstorage - npm Package Compare versions

Comparing version 3.0.0-alpha.1 to 3.0.0-alpha.3

index.d.ts

@@ -1,9 +0,8 @@
-type Dictionary = {
-  value: string;
-  set: (newValue: string) => void;
-  remove: () => void;
-};
-export default function useSessionstorage(
-  key: string,
-  defaultValue?: any
-): Dictionary;
+declare module "index" {
+    function useSessionStorage(key: string, defaultValue?: null): {
+        value: any;
+        set: (newValue: string | null) => void;
+        remove: () => null | undefined;
+    };
+    export default useSessionStorage;
+}

lib/index.browser.cjs.js

@@ -5,43 +5,70 @@ 'use strict';
 
-function _slicedToArray(arr, i) {
-  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest();
+function reducer(state, action) {
+    switch (action.type) {
+        case "set":
+            return (state = action.payload);
+        default:
+            return state;
+    }
 }
-
-function _arrayWithHoles(arr) {
-  if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(arr, i) {
-  var _arr = [];
-  var _n = true;
-  var _d = false;
-  var _e = undefined;
-
-  try {
-    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
-      _arr.push(_s.value);
-
-      if (i && _arr.length === i) break;
+function useSessionStorage(key, defaultValue) {
+    if (defaultValue === void 0) { defaultValue = null; }
+    var _a = react.useReducer(reducer, getValueFromSessionStorage()), value = _a[0], dispatch = _a[1];
+    function init() {
+        var initialValue = getValueFromSessionStorage();
+        if (initialValue === null || initialValue === "null") {
+            set(defaultValue);
+        }
     }
-  } catch (err) {
-    _d = true;
-    _e = err;
-  } finally {
-    try {
-      if (!_n && _i["return"] != null) _i["return"]();
-    } finally {
-      if (_d) throw _e;
+    function getValueFromSessionStorage() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.getItem(key);
     }
-  }
-
-  return _arr;
+    function saveValueToSessionStorage(key, value) {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.setItem(key, String(value));
+    }
+    function setValue(value) {
+        dispatch({
+            type: "set",
+            payload: value
+        });
+    }
+    function set(newValue) {
+        saveValueToSessionStorage(key, newValue);
+        setValue(newValue);
+    }
+    function remove() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        sessionStorage.removeItem(key);
+        setValue(null);
+    }
+    react.useEffect(function () {
+        init();
+    }, []);
+    function listen(e) {
+        if (e.storageArea === sessionStorage && e.key === key) {
+            set(e.newValue);
+        }
+    }
+    react.useEffect(function () {
+        window.addEventListener("storage", listen);
+        return function () {
+            window.removeEventListener("storage", listen);
+        };
+    }, []);
+    return {
+        value: value,
+        set: set,
+        remove: remove
+    };
 }
 
-function _nonIterableRest() {
-  throw new TypeError("Invalid attempt to destructure non-iterable instance");
-}
-
-function reducer(a,b){switch(b.type){case"set":return a=b.payload;default:return a;}}function useSessionStorage(a){function b(){var b=c(a);(null===b||"null"===b)&&f(h);}function c(){return "undefined"==typeof sessionStorage?null:sessionStorage.getItem(a)}function d(a,b){return "undefined"==typeof sessionStorage?null:sessionStorage.setItem(a,b)}function e(a){l({type:"set",payload:a});}function f(b){d(a,b),e(b);}function g(b){b.storageArea===sessionStorage&&b.key===a&&f(b.newValue);}var h=1<arguments.length&&void 0!==arguments[1]?arguments[1]:null,i=react.useReducer(reducer,c(a)),j=_slicedToArray(i,2),k=j[0],l=j[1];return react.useEffect(function(){b();},[]),react.useEffect(function(){return window.addEventListener("storage",g),function(){window.removeEventListener("storage",g);}},[]),{value:k,set:f,remove:function(){return "undefined"==typeof sessionStorage?null:void(sessionStorage.removeItem(a),e(null))}}}
-
 module.exports = useSessionStorage;
 //# sourceMappingURL=index.browser.cjs.js.map

lib/index.browser.esm.js

 import { useReducer, useEffect } from 'react';
 
-function _slicedToArray(arr, i) {
-  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest();
+function reducer(state, action) {
+    switch (action.type) {
+        case "set":
+            return (state = action.payload);
+        default:
+            return state;
+    }
 }
-
-function _arrayWithHoles(arr) {
-  if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(arr, i) {
-  var _arr = [];
-  var _n = true;
-  var _d = false;
-  var _e = undefined;
-
-  try {
-    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
-      _arr.push(_s.value);
-
-      if (i && _arr.length === i) break;
+function useSessionStorage(key, defaultValue) {
+    if (defaultValue === void 0) { defaultValue = null; }
+    var _a = useReducer(reducer, getValueFromSessionStorage()), value = _a[0], dispatch = _a[1];
+    function init() {
+        var initialValue = getValueFromSessionStorage();
+        if (initialValue === null || initialValue === "null") {
+            set(defaultValue);
+        }
     }
-  } catch (err) {
-    _d = true;
-    _e = err;
-  } finally {
-    try {
-      if (!_n && _i["return"] != null) _i["return"]();
-    } finally {
-      if (_d) throw _e;
+    function getValueFromSessionStorage() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.getItem(key);
     }
-  }
-
-  return _arr;
+    function saveValueToSessionStorage(key, value) {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.setItem(key, String(value));
+    }
+    function setValue(value) {
+        dispatch({
+            type: "set",
+            payload: value
+        });
+    }
+    function set(newValue) {
+        saveValueToSessionStorage(key, newValue);
+        setValue(newValue);
+    }
+    function remove() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        sessionStorage.removeItem(key);
+        setValue(null);
+    }
+    useEffect(function () {
+        init();
+    }, []);
+    function listen(e) {
+        if (e.storageArea === sessionStorage && e.key === key) {
+            set(e.newValue);
+        }
+    }
+    useEffect(function () {
+        window.addEventListener("storage", listen);
+        return function () {
+            window.removeEventListener("storage", listen);
+        };
+    }, []);
+    return {
+        value: value,
+        set: set,
+        remove: remove
+    };
 }
 
-function _nonIterableRest() {
-  throw new TypeError("Invalid attempt to destructure non-iterable instance");
-}
-
-function reducer(a,b){switch(b.type){case"set":return a=b.payload;default:return a;}}function useSessionStorage(a){function b(){var b=c(a);(null===b||"null"===b)&&f(h);}function c(){return "undefined"==typeof sessionStorage?null:sessionStorage.getItem(a)}function d(a,b){return "undefined"==typeof sessionStorage?null:sessionStorage.setItem(a,b)}function e(a){l({type:"set",payload:a});}function f(b){d(a,b),e(b);}function g(b){b.storageArea===sessionStorage&&b.key===a&&f(b.newValue);}var h=1<arguments.length&&void 0!==arguments[1]?arguments[1]:null,i=useReducer(reducer,c(a)),j=_slicedToArray(i,2),k=j[0],l=j[1];return useEffect(function(){b();},[]),useEffect(function(){return window.addEventListener("storage",g),function(){window.removeEventListener("storage",g);}},[]),{value:k,set:f,remove:function(){return "undefined"==typeof sessionStorage?null:void(sessionStorage.removeItem(a),e(null))}}}
-
 export default useSessionStorage;
 //# sourceMappingURL=index.browser.esm.js.map

lib/index.cjs.js

@@ -5,43 +5,70 @@ 'use strict';
 
-function _slicedToArray(arr, i) {
-  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest();
+function reducer(state, action) {
+    switch (action.type) {
+        case "set":
+            return (state = action.payload);
+        default:
+            return state;
+    }
 }
-
-function _arrayWithHoles(arr) {
-  if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(arr, i) {
-  var _arr = [];
-  var _n = true;
-  var _d = false;
-  var _e = undefined;
-
-  try {
-    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
-      _arr.push(_s.value);
-
-      if (i && _arr.length === i) break;
+function useSessionStorage(key, defaultValue) {
+    if (defaultValue === void 0) { defaultValue = null; }
+    var _a = react.useReducer(reducer, getValueFromSessionStorage()), value = _a[0], dispatch = _a[1];
+    function init() {
+        var initialValue = getValueFromSessionStorage();
+        if (initialValue === null || initialValue === "null") {
+            set(defaultValue);
+        }
     }
-  } catch (err) {
-    _d = true;
-    _e = err;
-  } finally {
-    try {
-      if (!_n && _i["return"] != null) _i["return"]();
-    } finally {
-      if (_d) throw _e;
+    function getValueFromSessionStorage() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.getItem(key);
     }
-  }
-
-  return _arr;
+    function saveValueToSessionStorage(key, value) {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.setItem(key, String(value));
+    }
+    function setValue(value) {
+        dispatch({
+            type: "set",
+            payload: value
+        });
+    }
+    function set(newValue) {
+        saveValueToSessionStorage(key, newValue);
+        setValue(newValue);
+    }
+    function remove() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        sessionStorage.removeItem(key);
+        setValue(null);
+    }
+    react.useEffect(function () {
+        init();
+    }, []);
+    function listen(e) {
+        if (e.storageArea === sessionStorage && e.key === key) {
+            set(e.newValue);
+        }
+    }
+    react.useEffect(function () {
+        window.addEventListener("storage", listen);
+        return function () {
+            window.removeEventListener("storage", listen);
+        };
+    }, []);
+    return {
+        value: value,
+        set: set,
+        remove: remove
+    };
 }
 
-function _nonIterableRest() {
-  throw new TypeError("Invalid attempt to destructure non-iterable instance");
-}
-
-function reducer(a,b){switch(b.type){case"set":return a=b.payload;default:return a;}}function useSessionStorage(a){function b(){var b=c(a);(null===b||"null"===b)&&f(h);}function c(){return "undefined"==typeof sessionStorage?null:sessionStorage.getItem(a)}function d(a,b){return "undefined"==typeof sessionStorage?null:sessionStorage.setItem(a,b)}function e(a){l({type:"set",payload:a});}function f(b){d(a,b),e(b);}function g(b){b.storageArea===sessionStorage&&b.key===a&&f(b.newValue);}var h=1<arguments.length&&void 0!==arguments[1]?arguments[1]:null,i=react.useReducer(reducer,c(a)),j=_slicedToArray(i,2),k=j[0],l=j[1];return react.useEffect(function(){b();},[]),react.useEffect(function(){return window.addEventListener("storage",g),function(){window.removeEventListener("storage",g);}},[]),{value:k,set:f,remove:function(){return "undefined"==typeof sessionStorage?null:void(sessionStorage.removeItem(a),e(null))}}}
-
 module.exports = useSessionStorage;
 //# sourceMappingURL=index.cjs.js.map

lib/index.esm.js

 import { useReducer, useEffect } from 'react';
 
-function _slicedToArray(arr, i) {
-  return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest();
+function reducer(state, action) {
+    switch (action.type) {
+        case "set":
+            return (state = action.payload);
+        default:
+            return state;
+    }
 }
-
-function _arrayWithHoles(arr) {
-  if (Array.isArray(arr)) return arr;
-}
-
-function _iterableToArrayLimit(arr, i) {
-  var _arr = [];
-  var _n = true;
-  var _d = false;
-  var _e = undefined;
-
-  try {
-    for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
-      _arr.push(_s.value);
-
-      if (i && _arr.length === i) break;
+function useSessionStorage(key, defaultValue) {
+    if (defaultValue === void 0) { defaultValue = null; }
+    var _a = useReducer(reducer, getValueFromSessionStorage()), value = _a[0], dispatch = _a[1];
+    function init() {
+        var initialValue = getValueFromSessionStorage();
+        if (initialValue === null || initialValue === "null") {
+            set(defaultValue);
+        }
     }
-  } catch (err) {
-    _d = true;
-    _e = err;
-  } finally {
-    try {
-      if (!_n && _i["return"] != null) _i["return"]();
-    } finally {
-      if (_d) throw _e;
+    function getValueFromSessionStorage() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.getItem(key);
     }
-  }
-
-  return _arr;
+    function saveValueToSessionStorage(key, value) {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        return sessionStorage.setItem(key, String(value));
+    }
+    function setValue(value) {
+        dispatch({
+            type: "set",
+            payload: value
+        });
+    }
+    function set(newValue) {
+        saveValueToSessionStorage(key, newValue);
+        setValue(newValue);
+    }
+    function remove() {
+        if (typeof sessionStorage === "undefined") {
+            return null;
+        }
+        sessionStorage.removeItem(key);
+        setValue(null);
+    }
+    useEffect(function () {
+        init();
+    }, []);
+    function listen(e) {
+        if (e.storageArea === sessionStorage && e.key === key) {
+            set(e.newValue);
+        }
+    }
+    useEffect(function () {
+        window.addEventListener("storage", listen);
+        return function () {
+            window.removeEventListener("storage", listen);
+        };
+    }, []);
+    return {
+        value: value,
+        set: set,
+        remove: remove
+    };
 }
 
-function _nonIterableRest() {
-  throw new TypeError("Invalid attempt to destructure non-iterable instance");
-}
-
-function reducer(a,b){switch(b.type){case"set":return a=b.payload;default:return a;}}function useSessionStorage(a){function b(){var b=c(a);(null===b||"null"===b)&&f(h);}function c(){return "undefined"==typeof sessionStorage?null:sessionStorage.getItem(a)}function d(a,b){return "undefined"==typeof sessionStorage?null:sessionStorage.setItem(a,b)}function e(a){l({type:"set",payload:a});}function f(b){d(a,b),e(b);}function g(b){b.storageArea===sessionStorage&&b.key===a&&f(b.newValue);}var h=1<arguments.length&&void 0!==arguments[1]?arguments[1]:null,i=useReducer(reducer,c(a)),j=_slicedToArray(i,2),k=j[0],l=j[1];return useEffect(function(){b();},[]),useEffect(function(){return window.addEventListener("storage",g),function(){window.removeEventListener("storage",g);}},[]),{value:k,set:f,remove:function(){return "undefined"==typeof sessionStorage?null:void(sessionStorage.removeItem(a),e(null))}}}
-
 export default useSessionStorage;
 //# sourceMappingURL=index.esm.js.map

lib/index.js

@@ -7,42 +7,69 @@ (function (global, factory) {
 
-  function _slicedToArray(arr, i) {
-    return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _nonIterableRest();
+  function reducer(state, action) {
+      switch (action.type) {
+          case "set":
+              return (state = action.payload);
+          default:
+              return state;
+      }
   }
-
-  function _arrayWithHoles(arr) {
-    if (Array.isArray(arr)) return arr;
-  }
-
-  function _iterableToArrayLimit(arr, i) {
-    var _arr = [];
-    var _n = true;
-    var _d = false;
-    var _e = undefined;
-
-    try {
-      for (var _i = arr[Symbol.iterator](), _s; !(_n = (_s = _i.next()).done); _n = true) {
-        _arr.push(_s.value);
-
-        if (i && _arr.length === i) break;
+  function useSessionStorage(key, defaultValue) {
+      if (defaultValue === void 0) { defaultValue = null; }
+      var _a = react.useReducer(reducer, getValueFromSessionStorage()), value = _a[0], dispatch = _a[1];
+      function init() {
+          var initialValue = getValueFromSessionStorage();
+          if (initialValue === null || initialValue === "null") {
+              set(defaultValue);
+          }
       }
-    } catch (err) {
-      _d = true;
-      _e = err;
-    } finally {
-      try {
-        if (!_n && _i["return"] != null) _i["return"]();
-      } finally {
-        if (_d) throw _e;
+      function getValueFromSessionStorage() {
+          if (typeof sessionStorage === "undefined") {
+              return null;
+          }
+          return sessionStorage.getItem(key);
       }
-    }
-
-    return _arr;
+      function saveValueToSessionStorage(key, value) {
+          if (typeof sessionStorage === "undefined") {
+              return null;
+          }
+          return sessionStorage.setItem(key, String(value));
+      }
+      function setValue(value) {
+          dispatch({
+              type: "set",
+              payload: value
+          });
+      }
+      function set(newValue) {
+          saveValueToSessionStorage(key, newValue);
+          setValue(newValue);
+      }
+      function remove() {
+          if (typeof sessionStorage === "undefined") {
+              return null;
+          }
+          sessionStorage.removeItem(key);
+          setValue(null);
+      }
+      react.useEffect(function () {
+          init();
+      }, []);
+      function listen(e) {
+          if (e.storageArea === sessionStorage && e.key === key) {
+              set(e.newValue);
+          }
+      }
+      react.useEffect(function () {
+          window.addEventListener("storage", listen);
+          return function () {
+              window.removeEventListener("storage", listen);
+          };
+      }, []);
+      return {
+          value: value,
+          set: set,
+          remove: remove
+      };
   }
 
-  function _nonIterableRest() {
-    throw new TypeError("Invalid attempt to destructure non-iterable instance");
-  }
-
-  function reducer(a,b){switch(b.type){case"set":return a=b.payload;default:return a;}}function useSessionStorage(a){function b(){var b=c(a);(null===b||"null"===b)&&f(h);}function c(){return "undefined"==typeof sessionStorage?null:sessionStorage.getItem(a)}function d(a,b){return "undefined"==typeof sessionStorage?null:sessionStorage.setItem(a,b)}function e(a){l({type:"set",payload:a});}function f(b){d(a,b),e(b);}function g(b){b.storageArea===sessionStorage&&b.key===a&&f(b.newValue);}var h=1<arguments.length&&void 0!==arguments[1]?arguments[1]:null,i=react.useReducer(reducer,c(a)),j=_slicedToArray(i,2),k=j[0],l=j[1];return react.useEffect(function(){b();},[]),react.useEffect(function(){return window.addEventListener("storage",g),function(){window.removeEventListener("storage",g);}},[]),{value:k,set:f,remove:function(){return "undefined"==typeof sessionStorage?null:void(sessionStorage.removeItem(a),e(null))}}}
-
   return useSessionStorage;
@@ -49,0 +76,0 @@

lib/index.min.js

@@ -1,2 +0,2 @@
-!function(e,n){"object"==typeof exports&&"undefined"!=typeof module?module.exports=n(require("react")):"function"==typeof define&&define.amd?define(["react"],n):(e=e||self).useSessionstorage=n(e.React)}(this,function(e){"use strict";function n(e,n){return function(e){if(Array.isArray(e))return e}(e)||function(e,n){var t=[],r=!0,o=!1,u=void 0;try{for(var i,s=e[Symbol.iterator]();!(r=(i=s.next()).done)&&(t.push(i.value),!n||t.length!==n);r=!0);}catch(e){o=!0,u=e}finally{try{r||null==s.return||s.return()}finally{if(o)throw u}}return t}(e,n)||function(){throw new TypeError("Invalid attempt to destructure non-iterable instance")}()}function t(e,n){switch(n.type){case"set":return n.payload;default:return e}}return function(r){function o(){return"undefined"==typeof sessionStorage?null:sessionStorage.getItem(r)}function u(e){l({type:"set",payload:e})}function i(e){(function(e,n){"undefined"==typeof sessionStorage||sessionStorage.setItem(e,n)})(r,e),u(e)}function s(e){e.storageArea===sessionStorage&&e.key===r&&i(e.newValue)}var f=1<arguments.length&&void 0!==arguments[1]?arguments[1]:null,a=n(e.useReducer(t,o()),2),c=a[0],l=a[1];return e.useEffect(function(){!function(){var e=o();(null===e||"null"===e)&&i(f)}()},[]),e.useEffect(function(){return window.addEventListener("storage",s),function(){window.removeEventListener("storage",s)}},[]),{value:c,set:i,remove:function(){return"undefined"==typeof sessionStorage?null:(sessionStorage.removeItem(r),void u(null))}}}});
+!function(e,n){"object"==typeof exports&&"undefined"!=typeof module?module.exports=n(require("react")):"function"==typeof define&&define.amd?define(["react"],n):(e=e||self).useSessionstorage=n(e.React)}(this,function(e){"use strict";function n(e,n){switch(n.type){case"set":return n.payload;default:return e}}return function(t,o){void 0===o&&(o=null);var s=e.useReducer(n,i()),u=s[0],r=s[1];function i(){return"undefined"==typeof sessionStorage?null:sessionStorage.getItem(t)}function f(e){r({type:"set",payload:e})}function a(e){!function(e,n){"undefined"==typeof sessionStorage||sessionStorage.setItem(e,String(n))}(t,e),f(e)}function c(e){e.storageArea===sessionStorage&&e.key===t&&a(e.newValue)}return e.useEffect(function(){var e;null!==(e=i())&&"null"!==e||a(o)},[]),e.useEffect(function(){return window.addEventListener("storage",c),function(){window.removeEventListener("storage",c)}},[]),{value:u,set:a,remove:function(){if("undefined"==typeof sessionStorage)return null;sessionStorage.removeItem(t),f(null)}}}});
 //# sourceMappingURL=index.min.js.map

package.json

@@ -5,2 +5,3 @@ {
   "module": "lib/index.esm.js",
+  "types": "index.d.ts",
   "description": "Session storage react hook. Easily manage session storage values",
@@ -17,3 +18,5 @@ "name": "@rooks/use-sessionstorage",
     "build": "rollup -c ../../scripts/rollup.config.js",
-    "prepublish": "yarn run build"
+    "prepublish": "yarn run build",
+    "pregenerate:types": "rimraf index.d.ts",
+    "generate:types": "tsc"
   },
@@ -28,3 +31,3 @@ "keywords": [
   ],
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.3",
   "_id": "@rooks/use-sessionstorage@",
@@ -38,3 +41,3 @@ "publishConfig": {
   },
-  "gitHead": "18191018f77a3b7a1823c6b79774f017109a60c8"
+  "gitHead": "e501b61df360375819f92ea53499ac11ac87187c"
 }

No alert changes

Improved metrics

Number of package files

31

increased by3.33%

Lines of code

805

increased by24.61%

Worsened metrics

Total package byte prevSize

79746

decreased by-1.03%

No dependency changes