Function debounce

src/utils/debounce.ts:8–56

(
  func: (...args: A) => void,
  wait?: number,
  immediate?: boolean,
)

 * @param { boolean } 	immediate		Param to define if the function will be executed immediately
 */
const debounce = <T, A extends any[]>(
  func: (...args: A) => void,
  wait?: number,
  immediate?: boolean,
) => {
  let timeout: NodeJS.Timeout | null = null
  let currentFunc = func

  const debounced = function debounced(this: T, ...args: A): void {
    const later = () => {
      timeout = null
      if (!immediate) {
        currentFunc.apply(this, args)
      }
    }

    if (immediate && !timeout) {
      /**
       * there's no need to clear the timeout
       * since we expect it to resolve and set `timeout = null`
       */
      currentFunc.apply(this, args)
      timeout = setTimeout(later, wait)
    }

    if (!immediate) {
      if (timeout) {
        clearTimeout(timeout)
      }
      timeout = setTimeout(later, wait)
    }
  }

  debounced.cancel = () => {
    /* c8 ignore start */
    if (!timeout) {
      return
    }
    /* c8 ignore end */
    clearTimeout(timeout)
    timeout = null
  }

  debounced.setCallback = (newFunc: (...args: A) => void) => {
    currentFunc = newFunc
  }

  return debounced
}

export default debounce