@siberiacancode/reactuse 0.0.54 → 0.0.56

package/dist/index.d.ts

@@ -1,6 +1,26 @@
-import { BatteryManager, EyeDropperConstructor, ColorSelectionOptions, ColorSelectionResult, Connection } from '@/utils/types';
 import * as react from 'react';
-import { RefObject, Dispatch, SetStateAction, EffectCallback, DependencyList, ComponentProps, useEffect } from 'react';
+import { DependencyList, RefObject, Dispatch, SetStateAction, EffectCallback, ComponentProps, useEffect } from 'react';
+import { BatteryManager, EyeDropperConstructor, ColorSelectionOptions, ColorSelectionResult, Connection } from '@/utils/types';
+
+interface UseAsyncReturn<Data> {
+    data?: Data;
+    isLoading: boolean;
+    isError: boolean;
+    error?: Error;
+}
+/**
+ * @name useAsync
+ * @description - Hook that provides the state of an async callback
+ * @category Utilities
+ *
+ * @param {() => Promise<Data>} callback - The async callback
+ * @param {DependencyList} [deps] - The dependencies of the callback
+ * @returns {UseAsyncReturn<Data>} - The state of the async callback
+ *
+ * @example
+ * const { data, isLoading, isError, error } = useAsync(() => fetch('url'), [deps]);
+ */
+declare const useAsync: <Data>(callback: () => Promise<Data>, deps?: DependencyList) => UseAsyncReturn<Data>;
 
 declare global {
     interface Navigator {
@@ -178,7 +198,7 @@ interface UseCounterOptions {
 /** The use counter return type */
 interface UseCounterReturn {
     /** The current count value */
-    count: number;
+    value: number;
     /** Function to set a specific value to the counter */
     set: Dispatch<SetStateAction<number>>;
     /** Function to reset the counter to its initial value. */
@@ -838,7 +858,7 @@ interface UseQueryReturn<Data> {
  * @returns {UseQueryReturn<Data>} An object with the state of the query
  *
  * @example
- * const { data, isLoading, isError, isSuccess, error, refetch, isRefetching } = useQuery(() => fetch('https://example.com/data'));
+ * const { data, isLoading, isError, isSuccess, error, refetch, isRefetching } = useQuery(() => fetch('url'));
  */
 declare const useQuery: <QueryData, Data = QueryData>(callback: () => Promise<QueryData>, options?: UseQueryOptions<QueryData, Data>) => UseQueryReturn<Data>;
 
@@ -1405,15 +1425,16 @@ type UseMouse = {
 declare const useMouse: UseMouse;
 
 interface UseMutationOptions<Data> {
-    retry?: boolean | number;
+    retry?: boolean | number | ((failureCount: number, error: Error) => boolean);
+    retryDelay?: number | ((retry: number, error: Error) => number);
     onSuccess?: (data: Data) => void;
     onError?: (error: Error) => void;
 }
 interface UseMutationReturn<Body, Data> {
     data: Data | null;
     error: Error | null;
-    mutate: (body: Body) => void;
-    mutateAsync: (body: Body) => Promise<Data>;
+    mutate: (body: Body, options?: UseMutationOptions<Data>) => void;
+    mutateAsync: (body: Body, options?: UseMutationOptions<Data>) => Promise<Data>;
     isLoading: boolean;
     isError: boolean;
     isSuccess: boolean;
@@ -2305,4 +2326,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-export { debounce, getDate, getRetry, isClient, isPermissionAllowed, throttle, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };
+export { debounce, getDate, getRetry, isClient, isPermissionAllowed, throttle, useAsync, useBattery, useBoolean, useBreakpoints, useBrowserLanguage, useClickOutside, useClipboard, useCounter, useDebounceCallback, useDebounceValue, useDefault, useDidUpdate, useDisclosure, useDocumentEvent, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useEyeDropper, useFavicon, useField, useFileDialog, useFps, useFullscreen, useGeolocation, useHash, useHotkeys, useHover, useIdle, useImage, useInfiniteScroll, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMap, useMeasure, useMediaQuery, useMemory, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePaint, usePermission, usePreferredColorScheme, usePreferredContrast, usePreferredDark, usePreferredLanguages, usePreferredReducedMotion, usePrevious, useQuery, useQueue, useRenderCount, useRenderInfo, useRerender, useResizeObserver, useScript, useSessionStorage, useSet, useShare, useStep, useStopwatch, useStorage, useTextSelection, useTime, useTimeout, useToggle, useUnmount, useWebSocket, useWindowEvent, useWindowSize, useWizard };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.54",
+  "version": "0.0.56",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

package/dist/cjs/_rollupPluginBabelHelpers-s0b9uPmg.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-s0b9uPmg.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}

package/dist/esm/_rollupPluginBabelHelpers-0IYrm-Ud.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"_rollupPluginBabelHelpers-0IYrm-Ud.js","sources":[],"sourcesContent":[],"names":[],"mappings":";"}