mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-10-22 19:26:13 +02:00
3732c5f71e
ESLint rules have been added to enforce our JSDoc conventions. These rules were introduced by updating `@metamask/eslint-config` to v9. Some of the rules have been disabled because the effort to fix all lint errors was too high. It might be easiest to enable these rules one directory at a time, or one rule at a time. Most of the changes in this PR were a result of running `yarn lint:fix`. There were a handful of manual changes that seemed obvious and simple to make. Anything beyond that and the rule was left disabled.
46 lines
963 B
JavaScript
46 lines
963 B
JavaScript
import { useState, useEffect, useRef, useCallback } from 'react';
|
|
|
|
/**
|
|
* useTimeout
|
|
*
|
|
* @param {Function} cb - callback function inside setTimeout
|
|
* @param {number} delay - delay in ms
|
|
* @param {boolean} [immediate] - determines whether the timeout is invoked immediately
|
|
* @returns {Function|undefined}
|
|
*/
|
|
export function useTimeout(cb, delay, immediate = true) {
|
|
const saveCb = useRef();
|
|
const [timeoutId, setTimeoutId] = useState(null);
|
|
|
|
useEffect(() => {
|
|
saveCb.current = cb;
|
|
}, [cb]);
|
|
|
|
useEffect(() => {
|
|
if (timeoutId !== 'start') {
|
|
return undefined;
|
|
}
|
|
|
|
const id = setTimeout(() => {
|
|
saveCb.current();
|
|
}, delay);
|
|
|
|
setTimeoutId(id);
|
|
|
|
return () => {
|
|
clearTimeout(timeoutId);
|
|
};
|
|
}, [delay, timeoutId]);
|
|
|
|
const startTimeout = useCallback(() => {
|
|
clearTimeout(timeoutId);
|
|
setTimeoutId('start');
|
|
}, [timeoutId]);
|
|
|
|
if (immediate) {
|
|
startTimeout();
|
|
}
|
|
|
|
return startTimeout;
|
|
}
|