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

debounceStrategy.md

46 lines1.0 KB

1---
2id: debounceStrategy
3title: debounceStrategy
4---
5​
6# Function: debounceStrategy()
7​
8```ts
9function debounceStrategy(options): DebounceStrategy;
10```
11​
12Defined in: [packages/db/src/strategies/debounceStrategy.ts:28](https://github.com/TanStack/db/blob/main/packages/db/src/strategies/debounceStrategy.ts#L28)
13​
14Creates a debounce strategy that delays transaction execution until after
15a period of inactivity.
16​
17Ideal for scenarios like search inputs or auto-save fields where you want
18to wait for the user to stop typing before persisting changes.
19​
20## Parameters
21​
22### options
23​
24[`DebounceStrategyOptions`](../interfaces/DebounceStrategyOptions.md)
25​
26Configuration for the debounce behavior
27​
28## Returns
29​
30[`DebounceStrategy`](../interfaces/DebounceStrategy.md)
31​
32A debounce strategy instance
33​
34## Example
35​
36```ts
37const mutate = usePacedMutations({
38 onMutate: (value) => {
39 collection.update(id, draft => { draft.value = value })
40 },
41 mutationFn: async ({ transaction }) => {
42 await api.save(transaction.mutations)
43 },
44 strategy: debounceStrategy({ wait: 500 })
45})
46```