Interface ThrottledFunction<F>

A throttled function, returned by throttle.

interface ThrottledFunction<F extends (...args: never[]) => unknown> {
    cancel(): void;
    flush(): void;
    (this: ThisParameterType<F>, ...args: Parameters<F>): void;
}

Type Parameters

F extends (...args: never[]) => unknown

ThrottledFunction(this: ThisParameterType<F>, ...args: Parameters<F>): void
Parameters
- this: ThisParameterType<F>
- ...args: Parameters<F>
Returns void
- Defined in utils/throttle.ts:14

Index

Methods

Methods

cancel

cancel(): void
Drops the pending call, if there is one.

Returns void
- Defined in utils/throttle.ts:16

flush

flush(): void
Makes the pending call right away, if there is one.

Returns void
- Defined in utils/throttle.ts:18