useDebouncedRefHistory

Category

State

Export Size

1.39 kB

Last Changed

4 days ago

Related

useRefHistoryuseThrottledRefHistory

Shorthand for useRefHistory with debounced filter.

Demo

sourceplayground (beta)

Count: 0

/
Delay (in ms):

History (limited to 10 records for demo)

2025-08-15 14:49:48{ value: 0 }

Usage

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

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

/**
 * 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

Source • Demo • Docs

Contributors

NoiseFan

Changelog

No recent changes