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

AsyncBatcherController.md

83 lines1.7 KB

1---
2id: AsyncBatcherController
3title: AsyncBatcherController
4---
5​
6Defined in: [async-batcher/AsyncBatcherController.ts:11](https://github.com/TanStack/pacer/blob/main/packages/lit-pacer/src/async-batcher/AsyncBatcherController.ts#L11)
7​
8Owns a AsyncBatcher for a Lit host. Access core methods and selected state through `pacer`.
9​
10## Type Parameters
11​
12### TValue
13​
14`TValue`
15​
16### TSelected
17​
18`TSelected` = \{
19\}
20​
21## Constructors
22​
23### Constructor
24​
25```ts
26new AsyncBatcherController<TValue, TSelected>(
27 host,
28 fn,
29 options?,
30selector?): AsyncBatcherController<TValue, TSelected>;
31```
32​
33Defined in: [async-batcher/AsyncBatcherController.ts:13](https://github.com/TanStack/pacer/blob/main/packages/lit-pacer/src/async-batcher/AsyncBatcherController.ts#L13)
34​
35#### Parameters
36​
37##### host
38​
39`ReactiveControllerHost`
40​
41##### fn
42​
43(`items`) => `Promise`\<`any`\>
44​
45##### options?
46​
47[`LitPacerOptions`](../type-aliases/LitPacerOptions.md)\<[`LitAsyncBatcherOptions`](../interfaces/LitAsyncBatcherOptions.md)\<`TValue`, `TSelected`\>\> = `{}`
48​
49##### selector?
50​
51(`state`) => `TSelected`
52​
53#### Returns
54​
55`AsyncBatcherController`\<`TValue`, `TSelected`\>
56​
57## Properties
58​
59### pacer
60​
61```ts
62readonly pacer: LitAsyncBatcher<TValue, TSelected>;
63```
64​
65Defined in: [async-batcher/AsyncBatcherController.ts:12](https://github.com/TanStack/pacer/blob/main/packages/lit-pacer/src/async-batcher/AsyncBatcherController.ts#L12)
66​
67## Accessors
68​
69### state
70​
71#### Get Signature
72​
73```ts
74get state(): Readonly<TSelected>;
75```
76​
77Defined in: [async-batcher/AsyncBatcherController.ts:23](https://github.com/TanStack/pacer/blob/main/packages/lit-pacer/src/async-batcher/AsyncBatcherController.ts#L23)
78​
79Selected reactive state. Reading this property participates in host rendering.
80​
81##### Returns
82​
83`Readonly`\<`TSelected`\>