@siberiacancode/reactuse 0.0.20 → 0.0.22

package/dist/index.d.ts

@@ -450,7 +450,7 @@ declare const useIdle: (milliseconds?: number, { initialValue, events }?: UseIdl
 
 type UseIntersectionObserverTarget = React.RefObject<Element | null> | (() => Element) | Element;
 interface UseIntersectionObserverOptions extends Omit<IntersectionObserverInit, 'root'> {
-    immediate?: boolean;
+    enabled?: boolean;
     onChange?: (entry: IntersectionObserverEntry) => void;
     root?: IntersectionObserverInit['root'] | React.RefObject<Element | null>;
 }
@@ -466,6 +466,49 @@ type UseIntersectionObserver = {
 };
 declare const useIntersectionObserver: UseIntersectionObserver;
 
+/** The use interval options */
+interface UseIntervalOptions {
+    /** Start the interval immediately */
+    enabled?: boolean;
+}
+/** The use interval return type */
+interface UseIntervalReturn {
+    /** Is the interval active */
+    isActive: boolean;
+    /** Pause the interval */
+    pause: () => void;
+    /** Resume the interval */
+    resume: () => void;
+}
+type UseInterval = {
+    (callback: () => void, interval?: number, options?: UseIntervalOptions): UseIntervalReturn;
+    (callback: () => void, options?: UseIntervalOptions & {
+        interval?: number;
+    }): UseIntervalReturn;
+};
+/**
+ * @name useInterval
+ * @description - Hook that makes and interval and returns controlling functions
+ *
+ * @overload
+ * @param {() => void} callback Any callback function
+ * @param {number} [interval=1000] Time in milliseconds
+ * @param {boolean} [options.immediate=true] Start the interval immediately
+ * @returns {UseIntervalReturn}
+ *
+ * @example
+ * const { isActive, pause, resume } = useInterval(() => console.log('inside interval'), 2500);
+ *
+ * @overload
+ * @param {() => void} callback Any callback function
+ * @param {number} [options.interval=1000] Time in milliseconds
+ * @param {boolean} [options.immediate=true] Start the interval immediately
+ *
+ * @example
+ * const { isActive, pause, resume } = useInterval(() => console.log('inside interval'), { interval: 2500 });
+ */
+declare const useInterval: UseInterval;
+
 /**
  * @name useIsFirstRender
  * @description - Hook that returns true if the component is first render
@@ -497,7 +540,7 @@ type UseKeyboardParams = {
 };
 /**
  * @name useKeyboard
- * @description - Hook that listens for key press events
+ * @description - Hook that help to listen for keyboard events
  *
  * @param {UseEventListenerTarget} [target=window] The target to attach the event listeners to
  * @param {(event: KeyboardEvent) => void} [onKeyDown] The callback function to be invoked on key down
@@ -1027,18 +1070,56 @@ declare const useScript: (src: string, options?: UseScriptOptions) => UseScriptS
  */
 declare const useSessionStorage: <Value>(key: string, initialValue?: UseStorageInitialValue<Value>, options?: UseStorageOptions<Value>) => readonly [Value | undefined, (value: Value) => void, () => void];
 
+declare global {
+    interface Set<T> {
+        union(other: Set<T>): Set<T>;
+        difference(other: Set<T>): Set<T>;
+        symmetricDifference(other: Set<T>): Set<T>;
+        intersection(other: Set<T>): Set<T>;
+        isDisjointFrom(other: Set<T>): boolean;
+        isSubsetOf(other: Set<T>): boolean;
+        isSupersetOf(other: Set<T>): boolean;
+    }
+}
+/** The use set return type */
+interface UseSetReturn<Value> {
+    /** The current set */
+    value: Set<Value>;
+    /** The size of the set */
+    size: number;
+    /** Function to check if a value exists in the set */
+    has: (value: Value) => boolean;
+    /** Function to add a value to the set */
+    add: (value: Value) => void;
+    /** Function to remove a value from the set */
+    remove: (value: Value) => void;
+    /** Function to clear the set */
+    clear: () => void;
+    /** Function to toggle a value in the set */
+    reset: () => void;
+    /** Function to toggle a value in the set */
+    toggle: (value: Value) => void;
+    /** Function to get the union of two sets */
+    union: (other: Set<Value>) => void;
+    /** Function to get the difference of two sets */
+    intersection: (other: Set<Value>) => void;
+    /** Function to get the symmetric difference of two sets */
+    difference: (other: Set<Value>) => void;
+    /** Function to get the symmetric difference of two sets */
+    symmetricDifference: (other: Set<Value>) => void;
+}
 /**
  * @name useSet
  * @description - Hook that manages a set structure
  *
  * @template Value The type of the value
  * @param {Value[]} [values] The initial array of the set
- * @returns {Set<Value>} A set structure
+ * @returns {UseSetReturn} An object containing the current set and functions to interact with the set
  *
  * @example
  * const set = useSet([1, 2, 3]);
  */
-declare const useSet: <Value>(values?: Value[]) => Set<Value>;
+declare const useSet: <Value>(values?: Value[]) => UseSetReturn<Value>;
 
 /** The use step params */
 interface UseStepParams {
@@ -1212,4 +1293,4 @@ declare const isClient: boolean;
 
 declare const throttle: <Params extends any[]>(callback: (...args: Params) => void, delay: number) => ((...args: Params) => void);
 
-export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseFaviconReturn, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseListReturn, type UseLongPress, type UseLongPressReturn, type UseLongPressTarget, type UseMouse, type UseMouseReturn, type UseNetworkReturn, type UseOrientationReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseToggleReturn, type UseWindowSizeReturn, debounce, dispatchStorageEvent, getConnection, getOperatingSystem, getRangesSelection, getRetry, isClient, isHotkeyMatch, legacyCopyToClipboard, throttle, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useFavicon, useFullscreen, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMediaQuery, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTextSelection, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };
+export { type ConnectionEffectiveType, type ConnectionType, type OperatingSystem, SCRIPT_STATUS_ATTRIBUTE_NAME, type UseClickOutside, type UseClickOutsideReturn, type UseCounter, type UseCounterOptions, type UseCounterParams, type UseCounterReturn, type UseDocumentTitleOptions, type UseDocumentTitleReturn, type UseEventListener, type UseEventListenerOptions, type UseEventListenerReturn, type UseEventListenerTarget, type UseFaviconReturn, type UseFullScreen, type UseFullScreenOptions, type UseFullScreenReturn, type UseHotkeysHotkeys, type UseHotkeysKey, type UseHotkeysOptions, type UseHover, type UseHoverOptions, type UseHoverReturn, type UseHoverTarget, type UseIdleReturn, type UseIntersectionObserver, type UseIntersectionObserverOptions, type UseIntersectionObserverReturn, type UseIntersectionObserverTarget, type UseIntervalOptions, type UseIntervalReturn, type UseKeyPressEvent, type UseKeyPressEventKey, type UseKeyPressKey, type UseKeyPressOptions, type UseKeyboardParams, type UseListReturn, type UseLongPress, type UseLongPressReturn, type UseLongPressTarget, type UseMouse, type UseMouseReturn, type UseNetworkReturn, type UseOrientationReturn, type UseQueueReturn, type UseScriptOptions, type UseScriptStatus, type UseStorageInitialValue, type UseStorageOptions, type UseStorageReturn, type UseTextSelectionReturn, type UseToggleReturn, type UseWindowSizeReturn, debounce, dispatchStorageEvent, getConnection, getOperatingSystem, getRangesSelection, getRetry, isClient, isHotkeyMatch, legacyCopyToClipboard, throttle, useBattery, useBoolean, useClickOutside, useCopyToClipboard, useCounter, useDebouncedValue, useDefault, useDidUpdate, useDocumentTitle, useDocumentVisibility, useEvent, useEventListener, useFavicon, useFullscreen, useHash, useHotkeys, useHover, useIdle, useIntersectionObserver, useInterval, useIsFirstRender, useIsomorphicLayoutEffect, useKeyPress, useKeyPressEvent, useKeyboard, useKeysPressed, useList, useLocalStorage, useLogger, useLongPress, useMediaQuery, useMount, useMouse, useMutation, useNetwork, useOnline, useOperatingSystem, useOrientation, usePageLeave, usePreferredLanguages, usePrevious, useQuery, useQueue, useRenderCount, useRerender, useScript, useSessionStorage, useSet, useStep, useStorage, useTextSelection, useTimeout, useToggle, useUnmount, useWindowEvent, useWindowSize };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.20",
+  "version": "0.0.22",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {
@@ -74,6 +74,7 @@
     "@types/react": "^18.3.2",
     "@types/react-dom": "^18.3.0",
     "comment-parser": "^1.4.1",
+    "core-js": "^3.37.1",
     "doctrine": "^3.0.0",
     "eslint": "^8.56.0",
     "husky": "^9.0.11",

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

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

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

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