Skip to content

refDebounced

Category
Export Size
440 B
Last Changed
3 hours ago
Alias
useDebouncedebouncedRef
Related

对 ref 的更新进行防抖。

Demo

此演示设置了 1000ms 的延迟。

Debounced:

更新次数: 0

用法

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'

你也可以传递一个可选的第三个参数,包括 maxWait 选项。详情请参阅 useDebounceFn

推荐阅读

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

SourceDemoDocs

Contributors

jorshen

Changelog

No recent changes

Released under the MIT License.