@sohanemon/utils 4.0.3 → 4.0.5

package/dist/hooks/index.d.ts

@@ -1,4 +1,4 @@
-import { EffectCallback } from 'react';
+import { Dispatch, EffectCallback, SetStateAction } from 'react';
 export declare const useClickOutside: (callback?: () => void) => any;
 export declare function useMediaQuery(tailwindBreakpoint: 'sm' | 'md' | 'lg' | 'xl' | '2xl' | `(${string})`): any;
 export declare function useEffectOnce(effect: EffectCallback): void;
@@ -7,3 +7,6 @@ export declare function useDebounce<T>(state: T, delay?: number): T;
 export declare const useIsomorphicEffect: any;
 export declare function useTimeout(callback: () => void, delay?: number | null): void;
 export declare function useWindowEvent<K extends string = keyof WindowEventMap>(type: K, listener: K extends keyof WindowEventMap ? (this: Window, ev: WindowEventMap[K]) => void : (this: Window, ev: CustomEvent) => void, options?: boolean | AddEventListenerOptions): void;
+type LocalStorageValue<T> = [T, Dispatch<SetStateAction<T>>];
+export declare const useLocalStorage: <T extends Record<string, any>>(key: string, defaultValue: T) => LocalStorageValue<T>;
+export {};

package/dist/hooks/index.js

@@ -101,3 +101,28 @@ export function useWindowEvent(type, listener, options) {
         return () => window.removeEventListener(type, listener, options);
     }, [type, listener]);
 }
+// Custom hook for using local storage with a specified key and default value
+export const useLocalStorage = (key, defaultValue) => {
+    const [storedValue, setStoredValue] = useState(defaultValue);
+    // Use effect to retrieve the stored value from local storage on component mount
+    useEffect(() => {
+        const value = localStorage.getItem(key);
+        if (value) {
+            setStoredValue(JSON.parse(value));
+        }
+    }, [key]);
+    // Function to update the stored value in local storage and state
+    const updateStoredValue = (valueOrFn) => {
+        let newValue;
+        if (typeof valueOrFn === 'function') {
+            const updateFunction = valueOrFn;
+            newValue = updateFunction(storedValue);
+        }
+        else {
+            newValue = valueOrFn;
+        }
+        localStorage.setItem(key, JSON.stringify(newValue));
+        setStoredValue(newValue);
+    };
+    return [storedValue, updateStoredValue];
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sohanemon/utils",
-  "version": "4.0.3",
+  "version": "4.0.5",
   "description": "",
   "source": "./src/index.ts",
   "main": "./dist/index.js",