DB Docs
API Reference
- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
AI/LLM: This documentation page is available in plain markdown format at/db/latest/docs/reference/functions/throttleStrategy.md
throttleStrategy
ts
function throttleStrategy(options): ThrottleStrategy;Defined in: packages/db/src/strategies/throttleStrategy.ts:49
Creates a throttle strategy that ensures transactions are evenly spaced over time.
Provides smooth, controlled execution patterns ideal for UI updates like sliders, progress bars, or scroll handlers where you want consistent execution timing.
Parameters#
options#
Configuration for throttle behavior
Returns#
A throttle strategy instance
Examples#
ts
// Throttle slider updates to every 200ms
const mutate = usePacedMutations({
onMutate: (volume) => {
settingsCollection.update('volume', draft => { draft.value = volume })
},
mutationFn: async ({ transaction }) => {
await api.updateVolume(transaction.mutations)
},
strategy: throttleStrategy({ wait: 200 })
})ts
// Throttle with leading and trailing execution
const mutate = usePacedMutations({
onMutate: (data) => {
collection.update(id, draft => { Object.assign(draft, data) })
},
mutationFn: async ({ transaction }) => {
await api.save(transaction.mutations)
},
strategy: throttleStrategy({
wait: 500,
leading: true,
trailing: true
})
})