useInterval

use-interval.ts

import { useEffect, useRef } from "react"

type UseIntervalOptions = {
  callback: () => void

  /** milliseconds */
  delay: number

  enabled?: boolean

  firstRun?: boolean
}

export function useInterval({
  callback,
  delay,
  enabled,
  firstRun,
}: UseIntervalOptions) {
  const callbackRef = useRef<() => void>(callback)

  useEffect(() => {
    callbackRef.current = callback
  }, [callback])

  useEffect(() => {
    if (!enabled) return

    if (firstRun) callbackRef.current()

    const interval = window.setInterval(() => {
      callbackRef.current()
    }, delay)

    return () => window.clearInterval(interval)
  }, [delay, enabled, firstRun])
}