@cripty2001/utils 0.0.245 → 0.0.246

package/dist/react-whispr.d.ts

@@ -66,7 +66,7 @@ export declare function useSynced<T extends any>(def: T, value: T | undefined, s
  *
  * @param f The async function to call. It should return a promise that resolves to the data. It is not reactive.
  * @param data The data to give to f. It must be stable, as anything in the dependency array of the useEffect and similars in the react ecosystem. If null, this function will act like an useEffect with an empty dependency array.
- * @param debouce Debounce time in ms. Default to 200ms. The async function will not be called if this time has not passed since the useAsync first invocation or value change. If another change happens during the wait, the first function call is never executed.
+ * @param debouce Debounce time in ms. Default to 200ms. The async function will not be called if this time has not passed since the useAsync first invocation or value change. If another change happens during the wait, the first function call is never executed. Not reactive
  * @returns A Dispatcher object containing:
  *   - `data`: A Whispr<DispatcherStatePayload<O>> that contains the loading state, progress, and either the result data or error
  *   - `filtered`: A Whispr<O | null> that contains the result data when successful, or null when loading or on error
@@ -87,7 +87,18 @@ export declare function useSynced<T extends any>(def: T, value: T | undefined, s
  *   console.error('Error:', state.error);
  * }
  */
-export declare function useAsync<I, O>(f: (input: I, setProgress: (p: number) => void, signal: AbortSignal) => Promise<O>, data: I, debouce?: number): Dispatcher<I, O>;
+export declare function useAsync<I, O>(f: (input: I, setProgress: (p: number) => void, signal: AbortSignal) => Promise<O>, data: I, debouce?: number): Dispatcher<any, O>;
+/**
+ * Like useAsync, but it also automatically re-execute the async function periodically
+ *
+ * @param f @see useAsync
+ * @param data @see useAsync
+ * @param interval The interval to re-execute the async function. If null, the async function will not be re-executed.
+ * @param debounce @see useAsync
+ *
+ * @returns @see useAsync
+ */
+export declare function useAsyncPeriodic<I, O>(f: (input: I, setProgress: (p: number) => void, signal: AbortSignal) => Promise<O>, data: I, interval: number, debounce?: number): Dispatcher<any, O>;
 /**
  * Async version of useEffect with debouncing. Executes an async function as a side effect when data changes.
  *

package/dist/react-whispr.js

@@ -8,6 +8,7 @@ exports.useClock = useClock;
 exports.useDebounced = useDebounced;
 exports.useSynced = useSynced;
 exports.useAsync = useAsync;
+exports.useAsyncPeriodic = useAsyncPeriodic;
 exports.useAsyncEffect = useAsyncEffect;
 exports.useRelTime = useRelTime;
 exports.useSearcher = useSearcher;
@@ -162,7 +163,7 @@ function useSynced(def, value, setValue) {
  *
  * @param f The async function to call. It should return a promise that resolves to the data. It is not reactive.
  * @param data The data to give to f. It must be stable, as anything in the dependency array of the useEffect and similars in the react ecosystem. If null, this function will act like an useEffect with an empty dependency array.
- * @param debouce Debounce time in ms. Default to 200ms. The async function will not be called if this time has not passed since the useAsync first invocation or value change. If another change happens during the wait, the first function call is never executed.
+ * @param debouce Debounce time in ms. Default to 200ms. The async function will not be called if this time has not passed since the useAsync first invocation or value change. If another change happens during the wait, the first function call is never executed. Not reactive
  * @returns A Dispatcher object containing:
  *   - `data`: A Whispr<DispatcherStatePayload<O>> that contains the loading state, progress, and either the result data or error
  *   - `filtered`: A Whispr<O | null> that contains the result data when successful, or null when loading or on error
@@ -196,6 +197,26 @@ function useAsync(f, data, debouce = 200) {
     // Returning dispatcher
     return dispatcher;
 }
+/**
+ * Like useAsync, but it also automatically re-execute the async function periodically
+ *
+ * @param f @see useAsync
+ * @param data @see useAsync
+ * @param interval The interval to re-execute the async function. If null, the async function will not be re-executed.
+ * @param debounce @see useAsync
+ *
+ * @returns @see useAsync
+ */
+function useAsyncPeriodic(f, data, interval, debounce) {
+    const timer = useClock(interval);
+    const bundle = (0, react_1.useMemo)(() => {
+        return {
+            data,
+            interval
+        };
+    }, [data, timer, debounce]);
+    return useAsync((i, p, s) => f(i.data, p, s), bundle, debounce);
+}
 /**
  * Async version of useEffect with debouncing. Executes an async function as a side effect when data changes.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cripty2001/utils",
-  "version": "0.0.245",
+  "version": "0.0.246",
   "description": "Internal Set of utils. If you need them use them, otherwise go to the next package ;)",
   "homepage": "https://github.com/cripty2001/utils#readme",
   "bugs": {