Throttler API Reference

ReactAsyncThrottlerOptions

Interface: ReactAsyncThrottlerOptions\

Defined in: react-pacer/src/async-throttler/useAsyncThrottler.ts:13

Extends

  • AsyncThrottlerOptions\<`TFn`\>

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Properties

onUnmount()?

ts
optional onUnmount: (throttler) => void;

Defined in: react-pacer/src/async-throttler/useAsyncThrottler.ts:21

Optional callback invoked when the component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc.

Parameters

throttler

ReactAsyncThrottler\<`TFn`, `TSelected`\>

Returns

void