@sohanemon/utils 4.1.7 → 4.1.9

package/dist/functions/index.d.ts

@@ -165,3 +165,28 @@ export declare function throttle<F extends (...args: any[]) => any>(function_: F
     leading?: boolean;
     trailing?: boolean;
 }): ThrottledFunction<F>;
+/**
+ * Formats a string by replacing each '%s' placeholder with the corresponding argument.
+ * This function mimics the basic behavior of C's printf for %s substitution.
+ *
+ * It supports both calls like `printf(format, ...args)` and `printf(format, argsArray)`.
+ *
+ * @param format - The format string containing '%s' placeholders.
+ * @param args - The values to substitute into the placeholders, either as separate arguments or as a single array.
+ * @returns The formatted string with all '%s' replaced by the provided arguments.
+ *
+ * @example
+ * ```ts
+ * const message = printf("%s love %s", "I", "Bangladesh");
+ * // message === "I love Bangladesh"
+ *
+ * const arr = ["I", "Bangladesh"];
+ * const message2 = printf("%s love %s", arr);
+ * // message2 === "I love Bangladesh"
+ *
+ * // If there are too few arguments:
+ * const incomplete = printf("Bangladesh is %s %s", "beautiful");
+ * // incomplete === "Bangladesh is beautiful"
+ * ```
+ */
+export declare function printf(format: string, ...args: unknown[]): string;

package/dist/functions/index.js

@@ -311,3 +311,35 @@ export function throttle(function_, wait = 100, options) {
     });
     return throttled;
 }
+/**
+ * Formats a string by replacing each '%s' placeholder with the corresponding argument.
+ * This function mimics the basic behavior of C's printf for %s substitution.
+ *
+ * It supports both calls like `printf(format, ...args)` and `printf(format, argsArray)`.
+ *
+ * @param format - The format string containing '%s' placeholders.
+ * @param args - The values to substitute into the placeholders, either as separate arguments or as a single array.
+ * @returns The formatted string with all '%s' replaced by the provided arguments.
+ *
+ * @example
+ * ```ts
+ * const message = printf("%s love %s", "I", "Bangladesh");
+ * // message === "I love Bangladesh"
+ *
+ * const arr = ["I", "Bangladesh"];
+ * const message2 = printf("%s love %s", arr);
+ * // message2 === "I love Bangladesh"
+ *
+ * // If there are too few arguments:
+ * const incomplete = printf("Bangladesh is %s %s", "beautiful");
+ * // incomplete === "Bangladesh is beautiful"
+ * ```
+ */
+export function printf(format, ...args) {
+    const replacements = args.length === 1 && Array.isArray(args[0]) ? args[0] : args;
+    let idx = 0;
+    return format.replace(/%s/g, () => {
+        const arg = replacements[idx++];
+        return arg === undefined ? '' : String(arg);
+    });
+}

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.7",
+  "version": "4.1.9",
   "author": "Sohan Emon <sohanemon@outlook.com>",
   "description": "",
   "type": "module",