Interface ThrottledFunction<T>

A throttled function with cancellation and introspection helpers.

interface ThrottledFunction<T extends (...args: never[]) => void> {
    cancel(): void;
    flush(): void;
    pending(): boolean;
    (...args: Parameters<T>): void;
}

Type Parameters

T extends (...args: never[]) => void

ThrottledFunction(...args: Parameters<T>): void
Parameters
- ...args: Parameters<T>
Returns void
- Defined in src/capabilities/std/timing.ts:282

Index

Methods

cancel flush pending

Methods

cancel

cancel(): void
Cancels any pending trailing invocation and resets timing state.

Returns void
- Defined in src/capabilities/std/timing.ts:284

flush

flush(): void
Runs a pending trailing invocation immediately when trailing delivery is enabled; otherwise it only clears the timer.

Returns void
- Defined in src/capabilities/std/timing.ts:289

pending

pending(): boolean
True while a trailing invocation is scheduled but has not run.

Returns boolean
- Defined in src/capabilities/std/timing.ts:291