Skip to content

Instantly share code, notes, and snippets.

@akhrszk
Last active March 31, 2023 04:37
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save akhrszk/776e7f136f8c167d9e66adff1a2d63e5 to your computer and use it in GitHub Desktop.
Save akhrszk/776e7f136f8c167d9e66adff1a2d63e5 to your computer and use it in GitHub Desktop.
React Hooks for using setInterval
import { useEffect, useRef, useState } from 'react';
type Control = {
start: () => void;
stop: () => void;
};
type State = 'RUNNING' | 'STOPPED';
type Fn = () => void;
export const useInterval = (fn: Fn, interval: number, autostart = true): [State, Control] => {
const onUpdateRef = useRef<Fn>();
const [state, setState] = useState<State>('STOPPED');
const start = () => {
setState('RUNNING');
};
const stop = () => {
setState('STOPPED');
};
useEffect(() => {
onUpdateRef.current = fn;
}, [fn]);
useEffect(() => {
if (autostart) {
setState('RUNNING');
}
}, [autostart]);
useEffect(() => {
let timerId: NodeJS.Timeout | undefined;
if (state === 'RUNNING') {
timerId = setInterval(() => {
onUpdateRef.current?.();
}, interval);
} else {
timerId && clearInterval(timerId);
}
return () => {
timerId && clearInterval(timerId);
};
}, [interval, state]);
return [state, { start, stop }];
};
export default useInterval;
@XxGodmoonxX
Copy link

@akhrszk
👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment