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

VueAsyncBatcher.md

89 lines2.0 KB

1---
2id: VueAsyncBatcher
3title: VueAsyncBatcher
4---
5​
6Defined in: [async-batcher/useAsyncBatcher.ts:22](https://github.com/TanStack/pacer/blob/main/packages/vue-pacer/src/async-batcher/useAsyncBatcher.ts#L22)
7​
8An AsyncBatcher with framework-reactive selected state. All core methods remain available.
9​
10## Extends
11​
12- `Omit`\<`AsyncBatcher`\<`TValue`\>, `"options"` \| `"setOptions"`\>
13​
14## Type Parameters
15​
16### TValue
17​
18`TValue`
19​
20### TSelected
21​
22`TSelected` = \{
23\}
24​
25## Properties
26​
27### options
28​
29```ts
30options: Omit<Required<AsyncBatcherOptions<TValue>>,
31 | "initialState"
32 | "key"
33 | "onError"
34 | "onSettled"
35 | "onSuccess"
36 | "onItemsChange"> & Partial<Pick<Required<AsyncBatcherOptions<TValue>>,
37 | "initialState"
38 | "key"
39 | "onError"
40 | "onSettled"
41 | "onSuccess"
42| "onItemsChange">> & VueAsyncBatcherOptions<TValue, TSelected>;
43```
44​
45Defined in: [async-batcher/useAsyncBatcher.ts:26](https://github.com/TanStack/pacer/blob/main/packages/vue-pacer/src/async-batcher/useAsyncBatcher.ts#L26)
46​
47***
48​
49### setOptions
50​
51```ts
52setOptions: (options) => void;
53```
54​
55Defined in: [async-batcher/useAsyncBatcher.ts:28](https://github.com/TanStack/pacer/blob/main/packages/vue-pacer/src/async-batcher/useAsyncBatcher.ts#L28)
56​
57#### Parameters
58​
59##### options
60​
61`Partial`\<[`VueAsyncBatcherOptions`](VueAsyncBatcherOptions.md)\<`TValue`, `TSelected`\>\>
62​
63#### Returns
64​
65`void`
66​
67***
68​
69### state
70​
71```ts
72readonly state: Readonly<ShallowRef<TSelected>>;
73```
74​
75Defined in: [async-batcher/useAsyncBatcher.ts:34](https://github.com/TanStack/pacer/blob/main/packages/vue-pacer/src/async-batcher/useAsyncBatcher.ts#L34)
76​
77Selected state. Pass a selector to opt in; the default selection is an empty object.
78​
79***
80​
81### Subscribe
82​
83```ts
84Subscribe: VuePacerSubscribe<AsyncBatcherState<TValue>>;
85```
86​
87Defined in: [async-batcher/useAsyncBatcher.ts:32](https://github.com/TanStack/pacer/blob/main/packages/vue-pacer/src/async-batcher/useAsyncBatcher.ts#L32)
88​
89Subscribes a scoped slot to state without re-rendering the utility owner.