Docs4dev
Docs
vueuse / latest / shared / refdebounced / index.html

refDebounced

Category Reactivity
Export Size 423 B
Last Changed 2 weeks ago
Alias useDebouncedebouncedRef
Related useThrottleFn

Debounce execution of a ref value.

Usage

import { refDebounced } from '@vueuse/core'

const input = ref('foo')
const debounced = refDebounced(input, 1000)

input.value = 'bar'
console.log(debounced.value) // 'foo'

await sleep(1100)

console.log(debounced.value) // 'bar'

You can also pass an optional 3rd parameter including maxWait option. See useDebounceFn for details.

Type Declarations

/**
 * Debounce updates of a ref.
 *
 * @return A new debounced ref.
 */
export declare function refDebounced<T>(
  value: Ref<T>,
  ms?: MaybeRefOrGetter<number>,
  options?: DebounceFilterOptions
): Readonly<Ref<T>>
export { refDebounced as useDebounce, refDebounced as debouncedRef }

Source

Source • Demo • Docs

© 2019-present Anthony Fu
Licensed under the MIT License.
https://vueuse.org/shared/refDebounced/