Skip to content

useDebouncedRefHistory

Category
Export Size
1.39 kB
Last Changed
6 months ago
Related

Shorthand for useRefHistory with debounced filter.

Demo

Count: 0
/
Delay (in ms):

History (limited to 10 records for demo)
2025-08-17 23:28:25{ value: 0 }

Usage

This function takes a snapshot of your counter after 1000ms when the value of it starts to change.

ts
import { 
useDebouncedRefHistory
} from '@vueuse/core'
import {
shallowRef
} from 'vue'
const
counter
=
shallowRef
(0)
const {
history
,
undo
,
redo
} =
useDebouncedRefHistory
(
counter
, {
deep
: true,
debounce
: 1000 })

Type Declarations

ts
/**
 * Shorthand for [useRefHistory](https://vueuse.org/useRefHistory) with debounce filter.
 *
 * @see https://vueuse.org/useDebouncedRefHistory
 * @param source
 * @param options
 */
export declare function 
useDebouncedRefHistory
<
Raw
,
Serialized
=
Raw
>(
source
:
Ref
<
Raw
>,
options
?:
Omit
<
UseRefHistoryOptions
<
Raw
,
Serialized
>, "eventFilter"> & {
debounce
?:
MaybeRefOrGetter
<number>
}, ):
UseRefHistoryReturn
<
Raw
,
Serialized
>

Source

SourceDemoDocs

Contributors

Anthony Fu
IlyaL
Anthony Fu
Roman Harmyder
Robin
OrbisK
wheat

Changelog

v12.8.0 on
7432f - feat(types): deprecate MaybeRef and MaybeRefOrGetter in favor of Vue's native (#4636)
v12.0.0-beta.1 on
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
v10.0.0-beta.4 on
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter

Released under the MIT License.

FREE WEEKEND
48 Hours of Unlimited Official Vue.js Certification Training
Reserve Your Spot
23-24 August