VueUse

Appearance

Return to top
On this page

useDebouncedRefHistory

Category
Last Changed
3 months ago

Shorthand for useRefHistorywith debounced filter.

Demo

source

Count: 0
/
Delay (in ms):

History (limited to 10 records for demo)
2022-03-05T07:29:36+00:00{ value: 0 }

Usage

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

import { ref } from 'vue' 
import { useDebouncedRefHistory } from '@vueuse/core'

const counter = ref(0)
const { history, undo, redo } = useDebouncedRefHistory(counter, { deep: true, debounce: 1000 })

import { ref } from 'vue' 
import { useDebouncedRefHistory } from '@vueuse/core'

const counter = ref(0)
const { history, undo, redo } = useDebouncedRefHistory(counter, { deep: true, debounce: 1000 })
  • useRefHistory
  • useThrottledRefHistory

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?: MaybeRef<number>
  }
): UseRefHistoryReturn<Raw, Serialized>

/**
 * 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?: MaybeRef<number>
  }
): UseRefHistoryReturn<Raw, Serialized>

Source

Source • Demo • Docs

Contributors

Anthony Fu
Roman Harmyder

Changelog

v6.3.3 on 9/12/2021
c05d5 - feat(useRefHistory): new option eventFilter, new functions useThrottledRefHistory and useDebouncedRefHistory (#740)