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

ReactAsyncQueuerOptions.md

44 lines915 Bytes

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