function usePacedMutations<TVariables, T>(config): (variables) => Transaction<T>;
function usePacedMutations<TVariables, T>(config): (variables) => Transaction<T>;
Defined in: usePacedMutations.ts:93
React hook for managing paced mutations with timing strategies.
Provides optimistic mutations with pluggable strategies like debouncing, queuing, or throttling. The optimistic updates are applied immediately via onMutate, and the actual persistence is controlled by the strategy.
TVariables = unknown
T extends object = Record<string, unknown>
PacedMutationsConfig<TVariables, T>
Configuration including onMutate, mutationFn and strategy
A mutate function that accepts variables and returns Transaction objects
(variables): Transaction<T>;
(variables): Transaction<T>;
TVariables
Transaction<T>
// Debounced auto-save
function AutoSaveForm({ formId }: { formId: string }) {
const mutate = usePacedMutations<string>({
onMutate: (value) => {
// Apply optimistic update immediately
formCollection.update(formId, draft => {
draft.content = value
})
},
mutationFn: async ({ transaction }) => {
await api.save(transaction.mutations)
},
strategy: debounceStrategy({ wait: 500 })
})
const handleChange = async (value: string) => {
const tx = mutate(value)
// Optional: await persistence or handle errors
try {
await tx.isPersisted.promise
console.log('Saved!')
} catch (error) {
console.error('Save failed:', error)
}
}
return <textarea onChange={e => handleChange(e.target.value)} />
}
// Debounced auto-save
function AutoSaveForm({ formId }: { formId: string }) {
const mutate = usePacedMutations<string>({
onMutate: (value) => {
// Apply optimistic update immediately
formCollection.update(formId, draft => {
draft.content = value
})
},
mutationFn: async ({ transaction }) => {
await api.save(transaction.mutations)
},
strategy: debounceStrategy({ wait: 500 })
})
const handleChange = async (value: string) => {
const tx = mutate(value)
// Optional: await persistence or handle errors
try {
await tx.isPersisted.promise
console.log('Saved!')
} catch (error) {
console.error('Save failed:', error)
}
}
return <textarea onChange={e => handleChange(e.target.value)} />
}
// Throttled slider updates
function VolumeSlider() {
const mutate = usePacedMutations<number>({
onMutate: (volume) => {
settingsCollection.update('volume', draft => {
draft.value = volume
})
},
mutationFn: async ({ transaction }) => {
await api.updateVolume(transaction.mutations)
},
strategy: throttleStrategy({ wait: 200 })
})
return <input type="range" onChange={e => mutate(+e.target.value)} />
}
// Throttled slider updates
function VolumeSlider() {
const mutate = usePacedMutations<number>({
onMutate: (volume) => {
settingsCollection.update('volume', draft => {
draft.value = volume
})
},
mutationFn: async ({ transaction }) => {
await api.updateVolume(transaction.mutations)
},
strategy: throttleStrategy({ wait: 200 })
})
return <input type="range" onChange={e => mutate(+e.target.value)} />
}
// Debounce with leading/trailing for color picker (persist first + final only)
function ColorPicker() {
const mutate = usePacedMutations<string>({
onMutate: (color) => {
themeCollection.update('primary', draft => {
draft.color = color
})
},
mutationFn: async ({ transaction }) => {
await api.updateTheme(transaction.mutations)
},
strategy: debounceStrategy({ wait: 0, leading: true, trailing: true })
})
return (
<input
type="color"
onChange={e => mutate(e.target.value)}
/>
)
}
// Debounce with leading/trailing for color picker (persist first + final only)
function ColorPicker() {
const mutate = usePacedMutations<string>({
onMutate: (color) => {
themeCollection.update('primary', draft => {
draft.color = color
})
},
mutationFn: async ({ transaction }) => {
await api.updateTheme(transaction.mutations)
},
strategy: debounceStrategy({ wait: 0, leading: true, trailing: true })
})
return (
<input
type="color"
onChange={e => mutate(e.target.value)}
/>
)
}
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.
