useDebouncedRefHistory

Category

State

Export Size

1.7 kB

Last Changed

6 minutes ago

Related

useRefHistoryuseThrottledRefHistory

Shorthand for useRefHistory with debounced filter.

Demo

source

Count: 0

/
Delay (in ms):

History (limited to 10 records for demo)

2024-11-21 08:50:49{ 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 { ref } from 'vue'

const counter = ref(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

Anthony Fu

Roman Harmyder

Anthony Fu

wheat

Changelog

v12.0.0-beta.1 on 11/21/2024

0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)

v10.0.0-beta.4 on 4/13/2023

4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter