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

AsyncDebouncerController.md

83 lines1.8 KB

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