⬅️ Back to Table of Contents

📄 index.ts

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	6
📊 Variables & Constants	1

📚 Table of Contents

• Imports
• Variables & Constants
• Functions

🛠️ File Location:

📂 packages/core/useDebouncedRefHistory/index.ts

📦 Imports

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

---

Variables & Constants

Name	Type	Kind	Value	Exported
filter	any	const	options.debounce ? debounceFilter(options.debounce) : undefined	✗

---

Functions

useDebouncedRefHistory(source: Ref<Raw>, options: Omit<UseRefHistoryOptions<Raw, Serialized>, 'eventFilter'> & { debounce?: MaybeRefOrGetter<number> }): UseRefHistoryReturn<Raw, Serialized>

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,
  }
}

• JSDoc:

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

• Parameters:

• source: Ref<Raw>
• options: Omit<UseRefHistoryOptions<Raw, Serialized>, 'eventFilter'> & { debounce?: MaybeRefOrGetter<number> }
• Return Type: UseRefHistoryReturn<Raw, Serialized>
• Calls:
• debounceFilter (from @vueuse/shared)
• useRefHistory (from ../useRefHistory)

---