mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-23 10:30:04 +01:00
14d85b1332
A few inconsistencies in JSDoc formatting have been fixed throughout the project. Many issues remain; these were just the few things that were easy to fix with a regular expression. The changes include: * Using lower-case for primitive types, but capitalizing non-primitive types * Separating the parameter identifier and the description with a dash * Omitting a dash between the return type and the return description * Ensuring the parameter type is first and the identifier is second (in a few places it was backwards) * Using square brackets to denote when a parameter is optional, rather than putting "(optional)" in the parameter description * Including a type and identifier with every parameter * Fixing inconsistent spacing, except where it's used for alignment * Remove incorrectly formatted `@deprecated` tags that reference non- existent properties * Remove lone comment block without accompanying function Additionally, one parameter was renamed for clarity.
47 lines
948 B
JavaScript
47 lines
948 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
|
|
*
|
|
* @return {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
|
|
}
|