@siberiacancode/reactuse 0.0.56 → 0.0.58

package/dist/index.d.ts

@@ -444,7 +444,7 @@ declare const useFavicon: (initialHref?: string) => {
     readonly set: (favicon: string) => void;
 };
 
-/** The use field params */
+/** The use field params type */
 interface UseFieldParams<Value> {
     /** The initial value */
     initialValue?: Value;
@@ -459,7 +459,7 @@ interface UseFieldParams<Value> {
     /** The validate on mount */
     validateOnMount?: boolean;
 }
-/** The use field register params */
+/** The use field register params type */
 interface UseFieldRegisterParams {
     /** The required validation */
     required?: string;
@@ -673,7 +673,7 @@ interface UseGeolocationReturn {
     /** The speed of the last position update */
     speed: number | null;
 }
-/** The use geolocation params */
+/** The use geolocation params type */
 type UseGeolocationParams = PositionOptions;
 /**
  * @name useGeolocation
@@ -704,7 +704,7 @@ type UseHashReturn = [string, (value: string) => void];
  */
 declare const useHash: () => UseHashReturn;
 
-/** The use hotkeys params */
+/** The use hotkeys params type */
 interface UseHotkeysOptions {
     /** The target to attach the event listeners to */
     target?: UseEventListenerTarget;
@@ -1003,7 +1003,7 @@ interface UseIntervalOptions {
 /** The use interval return type */
 interface UseIntervalReturn {
     /** Is the interval active */
-    isActive: boolean;
+    active: boolean;
     /** Pause the interval */
     pause: () => void;
     /** Resume the interval */
@@ -1027,7 +1027,7 @@ type UseInterval = {
  * @returns {UseIntervalReturn}
  *
  * @example
- * const { isActive, pause, resume } = useInterval(() => console.log('inside interval'), 2500);
+ * const { active, pause, resume } = useInterval(() => console.log('inside interval'), 2500);
  *
  * @overload
  * @param {() => void} callback Any callback function
@@ -1035,7 +1035,7 @@ type UseInterval = {
  * @param {boolean} [options.immediate=true] Start the interval immediately
  *
  * @example
- * const { isActive, pause, resume } = useInterval(() => console.log('inside interval'), { interval: 2500 });
+ * const { active, pause, resume } = useInterval(() => console.log('inside interval'), { interval: 2500 });
  */
 declare const useInterval: UseInterval;
 
@@ -1114,7 +1114,7 @@ type UseKeyPressEvent = {
 };
 declare const useKeyPressEvent: UseKeyPressEvent;
 
-/** The use keys pressed params */
+/** The use keys pressed params type */
 interface UseKeysPressedParams {
     /** The target to attach the event listeners to */
     target?: UseEventListenerTarget;
@@ -1778,6 +1778,56 @@ interface UseQueueReturn<Value> {
  */
 declare const useQueue: <Value>(initialValue?: Value[]) => UseQueueReturn<Value>;
 
+interface UseRafParams {
+    /** The delta between each frame in milliseconds */
+    delta: number;
+    /** The timestamp of the current frame in milliseconds */
+    timestamp: DOMHighResTimeStamp;
+}
+type UseRafCallback = (params: UseRafParams) => void;
+interface UseRafOptions {
+    /** The delay between each frame in milliseconds */
+    delay?: number;
+    /** Whether the callback should be enabled */
+    enabled?: boolean;
+}
+interface UseRafReturn {
+    /** Whether the callback is active */
+    active: boolean;
+    /** Function to pause the callback */
+    pause: () => void;
+    /** Function to resume the callback */
+    resume: () => void;
+}
+/**
+ * @name useRaf
+ * @description - Hook that defines the logic for raf callback
+ * @category Utilities
+ *
+ * @param {UseRafCallback} callback The callback to execute
+ * @param {number} [options.delay] The delay between each frame in milliseconds
+ * @param {boolean} [options.enabled=true] Whether the callback should be enabled
+ * @returns {UseRafCallbackReturn} An object of raf callback functions
+ *
+ * @example
+ * useRaf(() => console.log('callback'));
+ */
+declare const useRaf: (callback: UseRafCallback, options?: UseRafOptions) => UseRafReturn;
+
+/**
+ * @name useRafValue
+ * @description - Hook that returns the value and a function to set the value
+ * @category Utilities
+ *
+ * @template Value The type of the value
+ * @param {Value} initialValue The initial value
+ * @returns {UseRafValueReturn<Value>} An array containing the value and a function to set the value
+ *
+ * @example
+ * const [value, setValue] = useRafValue(initialValue);
+ */
+declare const useRafValue: <Value>(initialValue: Value | (() => Value)) => readonly [Value, (value: Value) => void];
+
 /**
  * @name useRenderCount
  * @description - Hook returns count component render times
@@ -1995,7 +2045,7 @@ declare const useShare: (params?: UseShareParams) => {
     supported: boolean;
 };
 
-/** The use step params */
+/** The use step params type */
 interface UseStepParams {
     /** Initial value for step */
     initial: number;
@@ -2326,4 +2376,4 @@ declare const getDate: (now?: Date) => {
     timestamp: number;
 };
 
-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 };
+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, useRaf, useRafValue, 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.56",
+  "version": "0.0.58",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {

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

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

package/dist/esm/_rollupPluginBabelHelpers-DzHsVrgu.js.map

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