import {useEffect} from 'react';
import {useSyncedRef} from '../useSyncedRef/index.js';

/**
 * Like `setInterval` but in the form of a React hook.
 *
 * @param callback Function to call within the interval.
 * @param ms Delay passed to the underlying `setInterval`. If set to `undefined`, the interval will
 * be cancelled. Keep in mind, that changing this parameter will reset the interval.
 */
export function useIntervalEffect(callback: () => void, ms?: number): void {
	const cbRef = useSyncedRef(callback);

	useEffect(() => {
		if (!ms && ms !== 0) {
			return;
		}

		const id = setInterval(() => {
			cbRef.current();
		}, ms);

		return () => {
			clearInterval(id);
		};
		// eslint-disable-next-line react-hooks/exhaustive-deps
	}, [ms]);
}