Throttler API Reference

ReactThrottlerOptions

Interface: ReactThrottlerOptions\

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

Extends

  • ThrottlerOptions\<`TFn`\>

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Properties

onUnmount()?

ts
optional onUnmount: (throttler) => void;

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

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

Parameters

throttler

ReactThrottler\<`TFn`, `TSelected`\>

Returns

void