feat: useTimer hook

src/shared/utils/index.ts

@@ -13,3 +13,4 @@ export * from "./helpers"
 export * from "./eventEmitter"
 export * from "./dictionary.map"
 export * from "./mixpanel"
+export * from "./useTimer"

src/shared/utils/useTimer.ts

@@ -0,0 +1,29 @@
+import { useCallback, useRef } from "react"
+
+type SetTimerProps = {
+  callback: () => void
+  delay: number
+}
+
+export const useTimer = () => {
+  const timerRef = useRef<number | undefined>(undefined)
+
+  // this resets the timer if it exists.
+  const resetTimer = useCallback(() => {
+    if (timerRef) window.clearTimeout(timerRef.current)
+  }, [timerRef])
+
+  const setTimer = useCallback(
+    (props: SetTimerProps) => {
+      timerRef.current = window.setTimeout(() => {
+        // clears any pending timer.
+        resetTimer()
+
+        props.callback()
+      }, props.delay)
+    },
+    [resetTimer],
+  )
+
+  return { setTimer, resetTimer }
+}