@monkvision/common 5.1.3 → 5.1.4

package/README/HOOKS.md

@@ -265,6 +265,19 @@ This hook returns takes a `ResponsiveStyleProperties` declarations object (see t
 `@monkvision/types` package for more details) containing a media query and returns either the CSSProperties contained in
 the type, or `null` if the query conditions are not met. Note that if there are no query, the style will be applied.
 
+
+### useSafeTimeout
+```tsx
+import { sights } from '@monkvision/sights';
+import { useSafeTimeout } from '@monkvision/common';
+
+function TestComponent() {
+  const setSafeTimeout = useSafeTimeout();
+  setSafeTimeout(() => console.log('test'), 1000);
+}
+```
+Custom hook that provides a safe way to use setTimeout.
+
 ### useSearchParams
 ```tsx
 import { sights } from '@monkvision/sights';

package/lib/hooks/index.d.ts

@@ -13,3 +13,4 @@ export * from './useObjectMemo';
 export * from './useForm';
 export * from './useIsMounted';
 export * from './useDeviceOrientation';
+export * from './useSafeTimeout';

package/lib/hooks/index.js

@@ -29,3 +29,4 @@ __exportStar(require("./useObjectMemo"), exports);
 __exportStar(require("./useForm"), exports);
 __exportStar(require("./useIsMounted"), exports);
 __exportStar(require("./useDeviceOrientation"), exports);
+__exportStar(require("./useSafeTimeout"), exports);

package/lib/hooks/useSafeTimeout.d.ts

@@ -0,0 +1,4 @@
+/**
+ * A custom hook that provides a safe way to use setTimeout.
+ */
+export declare function useSafeTimeout(): (callback: () => void, delay: number) => void;

package/lib/hooks/useSafeTimeout.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSafeTimeout = void 0;
+var react_1 = require("react");
+/**
+ * A custom hook that provides a safe way to use setTimeout.
+ */
+function useSafeTimeout() {
+    var isMounted = (0, react_1.useRef)(true);
+    var timeoutRef = (0, react_1.useRef)(null);
+    (0, react_1.useEffect)(function () {
+        return function () {
+            isMounted.current = false;
+            if (timeoutRef.current) {
+                clearTimeout(timeoutRef.current);
+            }
+        };
+    }, []);
+    return (0, react_1.useCallback)(function (callback, delay) {
+        timeoutRef.current = setTimeout(function () {
+            if (isMounted.current) {
+                callback();
+            }
+        }, delay);
+    }, []);
+}
+exports.useSafeTimeout = useSafeTimeout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monkvision/common",
-  "version": "5.1.3",
+  "version": "5.1.4",
   "license": "BSD-3-Clause-Clear",
   "packageManager": "yarn@3.2.4",
   "description": "MonkJs common logic package",
@@ -28,10 +28,10 @@
     "lint:fix": "yarn run prettier:fix && yarn run eslint:fix"
   },
   "dependencies": {
-    "@monkvision/analytics": "5.1.3",
-    "@monkvision/monitoring": "5.1.3",
-    "@monkvision/sights": "5.1.3",
-    "@monkvision/types": "5.1.3",
+    "@monkvision/analytics": "5.1.4",
+    "@monkvision/monitoring": "5.1.4",
+    "@monkvision/sights": "5.1.4",
+    "@monkvision/types": "5.1.4",
     "i18next": "^23.4.5",
     "jsonwebtoken": "^9.0.2",
     "jwt-decode": "^4.0.0",
@@ -47,13 +47,13 @@
     "react-router-dom": "^6.22.3"
   },
   "devDependencies": {
-    "@monkvision/eslint-config-base": "5.1.3",
-    "@monkvision/eslint-config-typescript": "5.1.3",
-    "@monkvision/eslint-config-typescript-react": "5.1.3",
-    "@monkvision/jest-config": "5.1.3",
-    "@monkvision/prettier-config": "5.1.3",
-    "@monkvision/test-utils": "5.1.3",
-    "@monkvision/typescript-config": "5.1.3",
+    "@monkvision/eslint-config-base": "5.1.4",
+    "@monkvision/eslint-config-typescript": "5.1.4",
+    "@monkvision/eslint-config-typescript-react": "5.1.4",
+    "@monkvision/jest-config": "5.1.4",
+    "@monkvision/prettier-config": "5.1.4",
+    "@monkvision/test-utils": "5.1.4",
+    "@monkvision/typescript-config": "5.1.4",
     "@testing-library/react": "^12.1.5",
     "@testing-library/react-hooks": "^8.0.1",
     "@types/jest": "^29.2.2",
@@ -96,5 +96,5 @@
     "url": "https://github.com/monkvision/monkjs/issues"
   },
   "homepage": "https://github.com/monkvision/monkjs",
-  "gitHead": "fc9a46364b6b20374800fad854057ef7d3b28c39"
+  "gitHead": "d6235358964c496cecbe3932fc00b03ac69e79eb"
 }