Interface ThrottledFunction<T, Args>

A throttled function that can be cancelled or flushed.

interface ThrottledFunction<T, Args extends unknown[] = unknown[]> {
    cancel(): void;
    flush(): void;
    pending(): boolean;
    (...args: Args): Promise<T>;
}

Type Parameters

T
Args extends unknown[] = unknown[]

ThrottledFunction(...args: Args): Promise<T>
Parameters
- ...args: Args
Returns Promise<T>
- Defined in packages/core/src/utils/throttle.ts:11

Index

Methods

cancel flush pending

Methods

cancel

cancel(): void
Returns void
- Defined in packages/core/src/utils/throttle.ts:12

flush

flush(): void
Returns void
- Defined in packages/core/src/utils/throttle.ts:13

pending

pending(): boolean
Returns boolean
- Defined in packages/core/src/utils/throttle.ts:14