@pushwoosh/kit-helpers 4.6.3 → 4.6.4

package/hooks/useAsyncFunction.d.ts

@@ -0,0 +1,29 @@
+import type { FunctionReturningPromise, PromiseType } from './types';
+export type AsyncFunctionState<T> = {
+    loading: boolean;
+    count: number;
+    error?: undefined;
+    value?: undefined;
+} | {
+    loading: true;
+    count: number;
+    error?: Error | undefined;
+    value?: T;
+} | {
+    loading: false;
+    count: number;
+    error: Error;
+    value?: undefined;
+} | {
+    loading: false;
+    count: number;
+    error?: undefined;
+    value: T;
+};
+type StateFromFunctionReturningPromise<T extends FunctionReturningPromise> = AsyncFunctionState<PromiseType<ReturnType<T>>>;
+export type AsyncFunctionReturn<T extends FunctionReturningPromise = FunctionReturningPromise> = [
+    StateFromFunctionReturningPromise<T>,
+    T
+];
+export default function useAsyncFunction<T extends FunctionReturningPromise>(fn: T): AsyncFunctionReturn<T>;
+export {};

package/hooks/useAsyncFunction.js

@@ -0,0 +1,44 @@
+import { useRef, useState } from 'react';
+import useMountedState from './useMountedState';
+import usePersistentFunction from './usePersistentFunction';
+const getDefaultState = () => ({
+  loading: false,
+  count: 0
+});
+export default function useAsyncFunction(fn) {
+  const countRef = useRef(0);
+  const isMounted = useMountedState();
+  const [state, setState] = useState(getDefaultState);
+  const execute = usePersistentFunction((...args) => {
+    // eslint-disable-next-line no-plusplus
+    const count = ++countRef.current;
+    const canSet = () => isMounted() && count === countRef.current;
+    if (canSet()) {
+      setState(prevState => ({
+        ...prevState,
+        count,
+        loading: true
+      }));
+    }
+    return fn(...args).then(value => {
+      if (canSet()) {
+        setState(prevState => ({
+          ...prevState,
+          value,
+          loading: false
+        }));
+      }
+      return value;
+    }, error => {
+      if (canSet()) {
+        setState(prevState => ({
+          ...prevState,
+          error,
+          loading: false
+        }));
+      }
+      throw error;
+    });
+  });
+  return [state, execute];
+}

package/index.d.ts

@@ -10,3 +10,4 @@ export { default as useAsync } from './hooks/useAsync';
 export { default as useAsyncFn } from './hooks/useAsyncFn';
 export { default as useDelayedValue } from './hooks/useDelayedValue';
 export { default as useDelayedEffect } from './hooks/useDelayedEffect';
+export { default as useAsyncFunction } from './hooks/useAsyncFunction';

package/index.js

@@ -9,4 +9,5 @@ export { default as useUnmount } from './hooks/useUnmount';
 export { default as useAsync } from './hooks/useAsync';
 export { default as useAsyncFn } from './hooks/useAsyncFn';
 export { default as useDelayedValue } from './hooks/useDelayedValue';
-export { default as useDelayedEffect } from './hooks/useDelayedEffect';
+export { default as useDelayedEffect } from './hooks/useDelayedEffect';
+export { default as useAsyncFunction } from './hooks/useAsyncFunction';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushwoosh/kit-helpers",
-  "version": "4.6.3",
+  "version": "4.6.4",
   "description": "React component for build Pushwoosh products",
   "main": "index.js",
   "module": "index.js",