@sohanemon/utils 4.1.8 → 4.1.9

package/dist/hooks/index.d.ts

@@ -47,6 +47,17 @@ export declare function useTimeout(callback: () => void, delay?: number | null):
  * @param options - Options for the event listener.
  */
 export declare function useWindowEvent<K extends keyof WindowEventMap>(type: K, listener: (this: Window, ev: WindowEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
+/**
+ * Tuple type for session storage value and updater.
+ */
+type SessionStorageValue<T> = [T, React.Dispatch<React.SetStateAction<T>>];
+/**
+ * Hook to persist state in session storage.
+ * @param key - The key for session storage.
+ * @param defaultValue - The default value if no value is found in session storage.
+ * @returns A tuple of the stored value and an updater function.
+ */
+export declare const useSessionStorage: <T extends Record<string, any>>(key: string, defaultValue: T) => SessionStorageValue<T>;
 /**
  * Tuple type for local storage value and updater.
  */

package/dist/hooks/index.js

@@ -140,6 +140,33 @@ export function useWindowEvent(type, listener, options) {
         return () => window.removeEventListener(type, listener, options);
     }, [type, listener, options]);
 }
+/**
+ * Hook to persist state in session storage.
+ * @param key - The key for session storage.
+ * @param defaultValue - The default value if no value is found in session storage.
+ * @returns A tuple of the stored value and an updater function.
+ */
+export const useSessionStorage = (key, defaultValue) => {
+    const [storedValue, setStoredValue] = React.useState(defaultValue);
+    React.useEffect(() => {
+        const value = sessionStorage.getItem(key);
+        if (value) {
+            setStoredValue(JSON.parse(value));
+        }
+    }, [key]);
+    const updateStoredValue = (valueOrFn) => {
+        let newValue;
+        if (typeof valueOrFn === 'function') {
+            newValue = valueOrFn(storedValue);
+        }
+        else {
+            newValue = valueOrFn;
+        }
+        sessionStorage.setItem(key, JSON.stringify(newValue));
+        setStoredValue(newValue);
+    };
+    return [storedValue, updateStoredValue];
+};
 /**
  * Hook to persist state in local storage.
  * @param key - The key for local storage.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sohanemon/utils",
-  "version": "4.1.8",
+  "version": "4.1.9",
   "author": "Sohan Emon <sohanemon@outlook.com>",
   "description": "",
   "type": "module",