Interface ThrottledFunctionExtras<R>

interface ThrottledFunctionExtras<R = unknown> {
    cancel: () => void;
    flush: () => undefined | R;
}

Type Parameters

  • R = unknown

Properties

Properties

cancel: () => void

Stops any planned calls (and resets the time array progress)

flush: () => undefined | R

Immediately runs planned call, returning its result (or the last cached result if nothing is planned).