Class Debounce<T, P>

A mechanism that defers function calls until no calls are received during a given interval.

Type Parameters

T
P extends any[]

Implements

ReusableResource

Index

Constructors

Methods

run flush cancel free

Constructors

constructor

new Debounce<T, P extends any[]>(
ms: number,
action: GenericFunction<P, MaybePromiseLike<T>>,
): Debounce<T, P>
Type Parameters
- T
- P extends any[]
Parameters
- ms: number
  delay in milliseconds
- action: GenericFunction<P, MaybePromiseLike<T>>
  underlying function
Returns Debounce<T, P>
- Defined in src/timing.ts:130

Methods

run

run(...parameters: P): Promise<T>
Schedule a call to the underlying function with the given parameters. If subsequent calls are made within the same interval, this call and its parameters are discarded.
Parameters
- ...parameters: P
Returns Promise<T>
- Defined in src/timing.ts:139

flush

flush(): void
If a call is currently scheduled, execute it immediately

Returns void
- Defined in src/timing.ts:153

cancel

cancel(reason?: any): void
Cancel any scheduled call
Parameters
- reason: any = ...
Returns void
- Defined in src/timing.ts:160

free

free(): void
Returns void
Implementation of ReusableResource.free
- Defined in src/timing.ts:167