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

AngularBatcherOptions.md

41 lines918 Bytes

1---
2id: AngularBatcherOptions
3title: AngularBatcherOptions
4---
5​
6Defined in: [packages/angular-pacer/src/batcher/injectBatcher.ts:28](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L28)
7​
8Options for [injectBatcher](../functions/injectBatcher.md), including core configuration and Angular cleanup.
9​
10## Extends
11​
12- `BatcherOptions`\<`TValue`\>
13​
14## Type Parameters
15​
16### TValue
17​
18`TValue`
19​
20## Properties
21​
22### onUnmount?
23​
24```ts
25optional onUnmount?: (core) => void;
26```
27​
28Defined in: [packages/angular-pacer/src/batcher/injectBatcher.ts:33](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L33)
29​
30Called when the owning injection context is destroyed. Receives the core instance.
31Providing this callback replaces the default cleanup (cancel pending batches).
32​
33#### Parameters
34​
35##### core
36​
37`Batcher`\<`TValue`\>
38​
39#### Returns
40​
41`void`