Skip to content

useDebouncedRefHistory ​

Category
Export Size
1.7 kB
Last Changed
11 months ago
Related

Shorthand for useRefHistory with debounced filter.

Demo ​

Count: 0
/
Delay (in ms):

History (limited to 10 records for demo)
2024-02-27 11:56:05{ value: 0 }

Usage ​

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

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

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

Type Declarations ​

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

Changelog ​

v10.0.0-beta.4 on 4/13/2023
4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter

Released under the MIT License.