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

LitBatcherOptions.md

45 lines780 Bytes

1---
2id: LitBatcherOptions
3title: LitBatcherOptions
4---
5​
6Defined in: [batcher/createBatcher.ts:10](https://github.com/TanStack/pacer/blob/main/packages/lit-pacer/src/batcher/createBatcher.ts#L10)
7​
8Options for createBatcher, including owner cleanup.
9​
10## Extends
11​
12- `BatcherOptions`\<`TValue`\>
13​
14## Type Parameters
15​
16### TValue
17​
18`TValue`
19​
20### TSelected
21​
22`TSelected` = \{
23\}
24​
25## Properties
26​
27### onUnmount?
28​
29```ts
30optional onUnmount?: (instance) => void;
31```
32​
33Defined in: [batcher/createBatcher.ts:15](https://github.com/TanStack/pacer/blob/main/packages/lit-pacer/src/batcher/createBatcher.ts#L15)
34​
35Replaces default cleanup. Use this to flush, cancel, or stop pending work.
36​
37#### Parameters
38​
39##### instance
40​
41[`LitBatcher`](LitBatcher.md)\<`TValue`, `TSelected`\>
42​
43#### Returns
44​
45`void`