⬅️ Back to Table of Contents

📄 useDebouncedRefHistory

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	6

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/core/useDebouncedRefHistory/index.ts

📦 Imports

Name	Source
MaybeRefOrGetter	vue
Ref	vue
UseRefHistoryOptions	../useRefHistory
UseRefHistoryReturn	../useRefHistory
debounceFilter	@vueuse/shared
useRefHistory	../useRefHistory

---

Functions

useDebouncedRefHistory(source: Ref<Raw>, options: Omit<UseRefHistoryOptions<Raw, Serializ…): UseRefHistoryReturn<Raw, Serialized>

Shorthand for useRefHistory with debounce filter.

Parameters:

• source any: No description
• options any: No description

See: https://vueuse.org/useDebouncedRefHistory

Raw JSDoc

/**
 * Shorthand for [useRefHistory](https://vueuse.org/useRefHistory) with debounce filter.
 *
 * @see https://vueuse.org/useDebouncedRefHistory
 * @param source
 * @param options
 */

Calls:

• debounceFilter (from @vueuse/shared)
• useRefHistory (from ../useRefHistory)

Code

export function useDebouncedRefHistory<Raw, Serialized = Raw>(
  source: Ref<Raw>,
  options: Omit<UseRefHistoryOptions<Raw, Serialized>, 'eventFilter'> & { debounce?: MaybeRefOrGetter<number> } = {},
): UseRefHistoryReturn<Raw, Serialized> {
  const filter = options.debounce ? debounceFilter(options.debounce) : undefined
  const history = useRefHistory(source, { ...options, eventFilter: filter })

  return {
    ...history,
  }
}

---

Generated by Syntax Scribe