Throttled | async-wrappers

A throttled function

Type parameters

F: (...args: any[]) => any
R: ReducerFunction<F, any>

Hierarchy

(...args: Args) => Promise<ReturnType<F>>
- Throttled

Callable

__call(...args: Args): Promise<ReturnType<F>>

- Defined in src/callReduce.ts:17
A throttled function

Parameters
- Rest ...args: Args
Returns Promise<ReturnType<F>>

Index

Methods

cancel
flush

Methods

cancel

cancel(reason?: Error): void

- Defined in src/throttle.ts:45
Cancels pending execution. Pending results will be rejected.

Parameters
- Optional reason: Error
  
  Optional reason to reject results with.
Returns void

flush

flush(): void

- Defined in src/throttle.ts:50
Causes any pending execution to fire on next runtime loop Subsequent calls will not defer this execution

Returns void

Generated using TypeDoc