use-local-storage - npm Package Compare versions

Comparing version 2.2.6 to 2.3.6

dist/index.d.ts

 /// <reference types="react" />
 declare type Serializer<T> = (object: T | undefined) => string;
 declare type Parser<T> = (val: string) => T | undefined;
-declare type Setter<T> = React.Dispatch<React.SetStateAction<T>>;
+declare type Setter<T> = React.Dispatch<React.SetStateAction<T | undefined>>;
 declare type Options<T> = Partial<{
@@ -12,3 +12,2 @@ serializer: Serializer<T>;
 declare function useLocalStorage<T>(key: string, defaultValue: T, options?: Options<T>): [T, Setter<T>];
-declare function useLocalStorage<T>(key: string, defaultValue?: undefined, options?: Options<T>): [T | undefined, Setter<T | undefined>];
 export default useLocalStorage;

dist/index.js

@@ -36,4 +36,12 @@ "use strict";
             return;
+        var updateLocalStorage = function () {
+            if (storedValue !== undefined) {
+                window.localStorage.setItem(key, serializer(storedValue));
+            }
+            else {
+                window.localStorage.removeItem(key);
+            }
+        };
         try {
-            window.localStorage.setItem(key, serializer(storedValue));
+            updateLocalStorage();
         }
@@ -40,0 +48,0 @@ catch (e) {

index.ts

@@ -5,3 +5,3 @@ import { useEffect, useMemo, useState } from "react";
 type Parser<T> = (val: string) => T | undefined;
-type Setter<T> = React.Dispatch<React.SetStateAction<T>>;
+type Setter<T> = React.Dispatch<React.SetStateAction<T | undefined>>;
 
@@ -22,7 +22,2 @@ type Options<T> = Partial<{
   key: string,
-  defaultValue?: undefined,
-  options?: Options<T>
-): [T | undefined, Setter<T | undefined>];
-function useLocalStorage<T>(
-  key: string,
   defaultValue?: T,
@@ -59,4 +54,12 @@ options?: Options<T>
 
+    const updateLocalStorage = () => {
+      if (storedValue !== undefined) {
+        window.localStorage.setItem(key, serializer(storedValue));
+      } else {
+        window.localStorage.removeItem(key);
+      }
+    }
+
     try {
-      window.localStorage.setItem(key, serializer(storedValue));
+      updateLocalStorage();
     } catch (e) {
@@ -63,0 +66,0 @@ logger(e);

package.json

 {
   "name": "use-local-storage",
-  "version": "2.2.6",
+  "version": "2.3.6",
   "description": "A flexible React Hook for using Local Storage.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -31,3 +31,3 @@ ![useLocalStorage React hook](https://raw.githubusercontent.com/nas5w/use-local-storage/master/uls-logo.png)
 
-The following usage will persist the `username` variable in a `"name"` key in Local Storage. It will have a default/initial value of an empty string `""`. This default value witll _only_ be used if there is no value already in Local Storage.
+The following usage will persist the `username` variable in a `"name"` key in Local Storage. It will have a default/initial value of an empty string `""`. This default value will _only_ be used if there is no value already in Local Storage, moreover setting the variable `username` to `undefined` will remove it from Local Storage.
 
@@ -48,2 +48,9 @@ ```jsx
       />
+      <button
+        onClick={() => {
+          setUsername(undefined);
+        }}
+      >
+        Remove Username
+      </button>
     </>
@@ -76,2 +83,9 @@ );
       />
+      <button
+        onClick={() => {
+          setUsername(undefined);
+        }}
+      >
+        Remove Username
+      </button>
     </>
@@ -78,0 +92,0 @@ );

No alert changes

Improved metrics

Total package byte prevSize

13232

increased by4.14%

Lines of code

177

increased by5.36%

Number of lines in readme file

119

increased by13.33%

No dependency changes