Skip to content
Source
Sign inSign up
TanStack/pacer
Open History to see the last commit

ReactThrottlerOptions.md

44 lines895 Bytes

1---
2id: ReactThrottlerOptions
3title: ReactThrottlerOptions
4---
5​
6Defined in: [throttler/useThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L13)
7​
8## Extends
9​
10- `ThrottlerOptions`\<`TFn`\>
11​
12## Type Parameters
13​
14### TFn
15​
16`TFn` *extends* `AnyFunction`
17​
18### TSelected
19​
20`TSelected` = \{
21\}
22​
23## Properties
24​
25### onUnmount?
26​
27```ts
28optional onUnmount?: (throttler) => void;
29```
30​
31Defined in: [throttler/useThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L21)
32​
33Optional callback invoked when the component unmounts. Receives the throttler instance.
34When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc.
35​
36#### Parameters
37​
38##### throttler
39​
40[`ReactThrottler`](ReactThrottler.md)\<`TFn`, `TSelected`\>
41​
42#### Returns
43​
44`void`