@siberiacancode/reactuse 0.0.12 → 0.0.14

package/dist/esm/index.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.12 */
-export{useBattery}from"./hooks/useBattery/useBattery.js";export{useBoolean}from"./hooks/useBoolean/useBoolean.js";export{useClickOutside}from"./hooks/useClickOutside/useClickOutside.js";export{legacyCopyToClipboard,useCopyToClipboard}from"./hooks/useCopyToClipboard/useCopyToClipboard.js";export{useCounter}from"./hooks/useCounter/useCounter.js";export{useDebouncedValue}from"./hooks/useDebouncedValue/useDebouncedValue.js";export{useDefault}from"./hooks/useDefault/useDefault.js";export{useDidUpdate}from"./hooks/useDidUpdate/useDidUpdate.js";export{useDocumentTitle}from"./hooks/useDocumentTitle/useDocumentTitle.js";export{useDocumentVisibility}from"./hooks/useDocumentVisibility/useDocumentVisibility.js";export{useEvent}from"./hooks/useEvent/useEvent.js";export{useEventListener}from"./hooks/useEventListener/useEventListener.js";export{useFavicon}from"./hooks/useFavicon/useFavicon.js";export{useHash}from"./hooks/useHash/useHash.js";export{isHotkeyMatch,useHotkeys}from"./hooks/useHotkeys/useHotkeys.js";export{useHover}from"./hooks/useHover/useHover.js";export{useIdle}from"./hooks/useIdle/useIdle.js";export{useIntersectionObserver}from"./hooks/useIntersectionObserver/useIntersectionObserver.js";export{useIsFirstRender}from"./hooks/useIsFirstRender/useIsFirstRender.js";export{useIsomorphicLayoutEffect}from"./hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";export{useKeyPress}from"./hooks/useKeyPress/useKeyPress.js";export{useKeyPressEvent}from"./hooks/useKeyPressEvent/useKeyPressEvent.js";export{useKeysPressed}from"./hooks/useKeysPressed/useKeysPressed.js";export{useLocalStorage}from"./hooks/useLocalStorage/useLocalStorage.js";export{useLogger}from"./hooks/useLogger/useLogger.js";export{useMediaQuery}from"./hooks/useMediaQuery/useMediaQuery.js";export{useMount}from"./hooks/useMount/useMount.js";export{getConnection,useNetwork}from"./hooks/useNetwork/useNetwork.js";export{useOnline}from"./hooks/useOnline/useOnline.js";export{getOperatingSystem,useOperatingSystem}from"./hooks/useOperatingSystem/useOperatingSystem.js";export{useOrientation}from"./hooks/useOrientation/useOrientation.js";export{usePageLeave}from"./hooks/usePageLeave/usePageLeave.js";export{usePrevious}from"./hooks/usePrevious/usePrevious.js";export{useQueue}from"./hooks/useQueue/useQueue.js";export{useRenderCount}from"./hooks/useRenderCount/useRenderCount.js";export{useRerender}from"./hooks/useRerender/useRerender.js";export{SCRIPT_STATUS_ATTRIBUTE_NAME,useScript}from"./hooks/useScript/useScript.js";export{useSessionStorage}from"./hooks/useSessionStorage/useSessionStorage.js";export{useSet}from"./hooks/useSet/useSet.js";export{useStep}from"./hooks/useStep/useStep.js";export{dispatchStorageEvent,useStorage}from"./hooks/useStorage/useStorage.js";export{useTimeout}from"./hooks/useTimeout/useTimeout.js";export{useToggle}from"./hooks/useToggle/useToggle.js";export{useUnmount}from"./hooks/useUnmount/useUnmount.js";export{useWindowEvent}from"./hooks/useWindowEvent/useWindowEvent.js";export{useWindowSize}from"./hooks/useWindowSize/useWindowSize.js";import"./_rollupPluginBabelHelpers-BrlXN-wU.js";import"react";import"./utils/helpers/debounce.js";import"./utils/helpers/isClient.js";import"./hooks/useMutationObserver.js";import"./utils/helpers/throttle.js";import"./utils/helpers/isShallowEqual.js";
+/* @license @siberiacancode/reactuse v0.0.14 */
+export{useBattery}from"./hooks/useBattery/useBattery.js";export{useBoolean}from"./hooks/useBoolean/useBoolean.js";export{useClickOutside}from"./hooks/useClickOutside/useClickOutside.js";export{legacyCopyToClipboard,useCopyToClipboard}from"./hooks/useCopyToClipboard/useCopyToClipboard.js";export{useCounter}from"./hooks/useCounter/useCounter.js";export{useDebouncedValue}from"./hooks/useDebouncedValue/useDebouncedValue.js";export{useDefault}from"./hooks/useDefault/useDefault.js";export{useDidUpdate}from"./hooks/useDidUpdate/useDidUpdate.js";export{useDocumentTitle}from"./hooks/useDocumentTitle/useDocumentTitle.js";export{useDocumentVisibility}from"./hooks/useDocumentVisibility/useDocumentVisibility.js";export{useEvent}from"./hooks/useEvent/useEvent.js";export{useEventListener}from"./hooks/useEventListener/useEventListener.js";export{useFavicon}from"./hooks/useFavicon/useFavicon.js";export{useHash}from"./hooks/useHash/useHash.js";export{isHotkeyMatch,useHotkeys}from"./hooks/useHotkeys/useHotkeys.js";export{useHover}from"./hooks/useHover/useHover.js";export{useIdle}from"./hooks/useIdle/useIdle.js";export{useIntersectionObserver}from"./hooks/useIntersectionObserver/useIntersectionObserver.js";export{useIsFirstRender}from"./hooks/useIsFirstRender/useIsFirstRender.js";export{useIsomorphicLayoutEffect}from"./hooks/useIsomorphicLayoutEffect/useIsomorphicLayoutEffect.js";export{useKeyPress}from"./hooks/useKeyPress/useKeyPress.js";export{useKeyPressEvent}from"./hooks/useKeyPressEvent/useKeyPressEvent.js";export{useKeysPressed}from"./hooks/useKeysPressed/useKeysPressed.js";export{useLocalStorage}from"./hooks/useLocalStorage/useLocalStorage.js";export{useLogger}from"./hooks/useLogger/useLogger.js";export{useMediaQuery}from"./hooks/useMediaQuery/useMediaQuery.js";export{useMount}from"./hooks/useMount/useMount.js";export{getConnection,useNetwork}from"./hooks/useNetwork/useNetwork.js";export{useOnline}from"./hooks/useOnline/useOnline.js";export{getOperatingSystem,useOperatingSystem}from"./hooks/useOperatingSystem/useOperatingSystem.js";export{useOrientation}from"./hooks/useOrientation/useOrientation.js";export{usePageLeave}from"./hooks/usePageLeave/usePageLeave.js";export{usePrevious}from"./hooks/usePrevious/usePrevious.js";export{useQueue}from"./hooks/useQueue/useQueue.js";export{useRenderCount}from"./hooks/useRenderCount/useRenderCount.js";export{useRerender}from"./hooks/useRerender/useRerender.js";export{SCRIPT_STATUS_ATTRIBUTE_NAME,useScript}from"./hooks/useScript/useScript.js";export{useSessionStorage}from"./hooks/useSessionStorage/useSessionStorage.js";export{useSet}from"./hooks/useSet/useSet.js";export{useStep}from"./hooks/useStep/useStep.js";export{dispatchStorageEvent,useStorage}from"./hooks/useStorage/useStorage.js";export{useTimeout}from"./hooks/useTimeout/useTimeout.js";export{useToggle}from"./hooks/useToggle/useToggle.js";export{useUnmount}from"./hooks/useUnmount/useUnmount.js";export{useWindowEvent}from"./hooks/useWindowEvent/useWindowEvent.js";export{useWindowSize}from"./hooks/useWindowSize/useWindowSize.js";import"./_rollupPluginBabelHelpers-BD_D7dtZ.js";import"react";import"./utils/helpers/debounce.js";import"./utils/helpers/isClient.js";import"./hooks/useMutationObserver.js";import"./utils/helpers/throttle.js";import"./utils/helpers/isShallowEqual.js";import"./index-B8ndwmOB.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/utils/helpers/debounce.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.12 */
+/* @license @siberiacancode/reactuse v0.0.14 */
 var r=function(r,n){var t;return function(){for(var e=arguments.length,o=new Array(e),u=0;u<e;u++)o[u]=arguments[u];clearTimeout(t),t=setTimeout((function(){return r.apply(void 0,o)}),n)}};export{r as debounce};
 //# sourceMappingURL=debounce.js.map

package/dist/esm/utils/helpers/index.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.12 */
+/* @license @siberiacancode/reactuse v0.0.14 */
 export{debounce}from"./debounce.js";export{isClient}from"./isClient.js";export{isShallowEqual}from"./isShallowEqual.js";export{throttle}from"./throttle.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/utils/helpers/isClient.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.12 */
+/* @license @siberiacancode/reactuse v0.0.14 */
 var n,d,e=!("undefined"==typeof window||null===(n=window)||void 0===n||!n.document||null===(d=window)||void 0===d||null===(d=d.document)||void 0===d||!d.createElement);export{e as isClient};
 //# sourceMappingURL=isClient.js.map

package/dist/esm/utils/helpers/isShallowEqual.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.12 */
+/* @license @siberiacancode/reactuse v0.0.14 */
 var r=function(r,e){var t=Object.keys(r),n=Object.keys(e);if(t.length!==n.length)return!1;for(var a=0,f=t;a<f.length;a++){var u=f[a];if(r[u]!==e[u])return!1}return!0};export{r as isShallowEqual};
 //# sourceMappingURL=isShallowEqual.js.map

package/dist/esm/utils/helpers/throttle.js

@@ -1,3 +1,3 @@
-/* @license @siberiacancode/reactuse v0.0.12 */
+/* @license @siberiacancode/reactuse v0.0.14 */
 var n=function(n,t){var o=!1;return function(){o||(n.apply(void 0,arguments),o=!0,setTimeout((function(){o=!1}),t))}};export{n as throttle};
 //# sourceMappingURL=throttle.js.map

package/dist/index.d.ts

@@ -220,6 +220,18 @@ declare function useDocumentTitle(value?: string, options?: UseDocumentTitleOpti
  */
 declare const useDocumentVisibility: () => DocumentVisibilityState;
 
+/**
+ * @name useEvent
+ * @description - Hook that creates an event and returns a stable reference of it
+ *
+ * @template Params The type of the params
+ * @template Return The type of the return
+ * @param {(...args: Params) => Return} callback The callback function
+ * @returns {(...args: Params) => Return} The callback
+ *
+ * @example
+ * const onClick = useEvent(() => console.log('clicked'));
+ */
 declare const useEvent: <Params extends unknown[], Return>(callback: (...args: Params) => Return) => ((...args: Params) => Return);
 
 type UseEventListenerTarget = React.RefObject<Element | null> | (() => Element) | Element | Window | Document;
@@ -539,9 +551,9 @@ interface UseNetworkReturn {
 declare const getConnection: () => Connection;
 /**
  * @name useNetwork
- * @description - Hook to track network status.
+ * @description - Hook to track network status
  *
- * @returns {UseNetworkReturn} An object containing the network status.
+ * @returns {UseNetworkReturn} An object containing the network status
  *
  * @example
  * const { online, downlink, downlinkMax, effectiveType, rtt, saveData, type } = useNetwork();
@@ -779,14 +791,14 @@ interface UseTimeoutReturn {
 }
 /**
  * @name useTimeout
- * @description Hook that executes a callback function after a specified delay.
+ * @description Hook that executes a callback function after a specified delay
  *
- * @param {() => void} callback The function to be executed after the timeout.
- * @param {number} delay The delay in milliseconds before the timeout executes the callback function.
- * @returns {UseTimeoutReturn} An object with a `ready` boolean state value and a `clear` function to clear timeout.
+ * @param {() => void} callback The function to be executed after the timeout
+ * @param {number} delay The delay in milliseconds before the timeout executes the callback function
+ * @returns {UseTimeoutReturn} An object with a `ready` boolean state value and a `clear` function to clear timeout
  *
  * @example
- * const { clear, ready } = useTimeout(() => {}, 5000)
+ * const { clear, ready } = useTimeout(() => {}, 5000);
  */
 declare function useTimeout(callback: () => void, delay: number): UseTimeoutReturn;
 
@@ -805,7 +817,7 @@ type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];
  * @example
  * const [value, toggle] = useToggle(['light', 'dark'] as const);
  */
-declare const useToggle: <Value = boolean>(values?: readonly Value[]) => readonly [Value, (value?: Value) => void];
+declare const useToggle: <Value = boolean>(values?: readonly Value[]) => readonly [Value, (value?: React.SetStateAction<Value>) => void];
 
 /**
  * @name useUnmount
@@ -857,7 +869,7 @@ interface UseWindowSizeReturn {
  * @returns {UseWindowSizeReturn} An object containing the current window width and height
  *
  * @example
- * const { width, height } = useWindowSize()
+ * const { width, height } = useWindowSize();
  */
 declare const useWindowSize: (params?: UseWindowSizeParams) => {
     width: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Ultimate tool",
   "license": "MIT",
   "author": {
@@ -64,6 +64,7 @@
     "@siberiacancode/builder": "^1.3.0",
     "@siberiacancode/eslint": "^1.1.0",
     "@siberiacancode/prettier": "^1.1.0",
+    "@siberiacancode/vitest": "^1.2.3",
     "@testing-library/jest-dom": "^6.4.5",
     "@testing-library/react": "^15.0.7",
     "@types/doctrine": "^0.0.9",
@@ -74,7 +75,6 @@
     "doctrine": "^3.0.0",
     "eslint": "^8.56.0",
     "husky": "^9.0.11",
-    "jsdom": "^24.1.0",
     "lint-staged": "^15.2.2",
     "markdown-table": "^3.0.3",
     "react": "^18.2.0",
@@ -82,8 +82,7 @@
     "shx": "^0.3.4",
     "typescript": "^5.3.3",
     "vite": "^5.1.3",
-    "vitepress": "^1.1.4",
-    "vitest": "^1.6.0"
+    "vitepress": "^1.1.4"
   },
   "keywords": [
     "react",

package/dist/cjs/_rollupPluginBabelHelpers-M-utHMXq.js.map

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

package/dist/esm/_rollupPluginBabelHelpers-BrlXN-wU.js.map

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