refDebounced
Category
Export Size
440 B
Last Changed
3 weeks ago
Alias
useDebouncedebouncedRef Related
Debounce execution of a ref value.
Demo
Delay is set to 1000ms for this demo.
Debounced:
Times Updated: 0
Usage
js
import { refDebounced } from '@vueuse/core'
import { shallowRef } from 'vue'
const input = shallowRef('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.
Recommended Reading
Type Declarations
typescript
/**
* 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 debouncedRef, refDebounced as useDebounce }Source
Contributors
Anthony Fu
IlyaL
Anthony Fu
Thimo Sietsma
Dominik Klein