⬅️ Back to Table of Contents

📄 useDebounceFn

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	6
📑 Type Aliases	1

📚 Table of Contents

• Imports
• Functions
• Type Aliases

🛠️ File Location:

📂 packages/shared/useDebounceFn/index.ts

📦 Imports

Name	Source
MaybeRefOrGetter	vue
CancelablePromisifyFn	../utils
DebounceFilterOptions	../utils
FunctionArgs	../utils
createFilterWrapper	../utils
debounceFilter	../utils

---

Functions

useDebounceFn(fn: T, ms: MaybeRefOrGetter<number>, options: DebounceFilterOptions): UseDebounceFnReturn<T>

Debounce execution of a function.

Parameters:

• fn any: A function to be executed after delay milliseconds debounced.
• ms any: A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
• options any: Options

Returns: undefined A new, debounced, function with isPending, cancel, and flush properties.

See: https://vueuse.org/useDebounceFn

Raw JSDoc

/**
 * Debounce execution of a function.
 *
 * @see https://vueuse.org/useDebounceFn
 * @param  fn          A function to be executed after delay milliseconds debounced.
 * @param  ms          A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
 * @param  options     Options
 *
 * @return A new, debounced, function with isPending, cancel, and flush properties.
 */

Calls:

• createFilterWrapper (from ../utils)
• debounceFilter (from ../utils)

Code

export function useDebounceFn<T extends FunctionArgs>(
  fn: T,
  ms: MaybeRefOrGetter<number> = 200,
  options: DebounceFilterOptions = {},
): UseDebounceFnReturn<T> {
  return createFilterWrapper(debounceFilter(ms, options), fn)
}

---

Type Aliases

UseDebounceFnReturn<T extends FunctionArgs>

type UseDebounceFnReturn<T extends FunctionArgs> = CancelablePromisifyFn<T>;

---

Generated by Syntax Scribe