refDebounced

类别

Reactivity

导出体积

423 B

上次更改

3 minutes ago

别名

useDebouncedebouncedRef

相关

useThrottleFn

对 ref 的更新进行防抖。

示例

源码

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

Debounced:

更新次数: 0

用法

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'

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

推荐阅读

• 防抖与节流：完整的可视化指南

类型声明

/**
 * 对 ref 的更新进行防抖。
 *
 * @return 一个新的防抖 Ref
 */
export declare function refDebounced<T>(
  value: Ref<T>,
  ms?: MaybeRefOrGetter<number>,
  options?: DebounceFilterOptions,
): Readonly<Ref<T>>
export { refDebounced as useDebounce, refDebounced as debouncedRef }

源码

源码 • 演示 • 文档

贡献者

Anthony Fu

一纸忘忧

Anthony Fu

Dominik Klein

更新日志

v10.0.0-beta.4 on 4/13/2023

4d757 - feat(types)!: rename MaybeComputedRef to MaybeRefOrGetter

v9.4.0 on 10/25/2022

ce3dc - feat: use MaybeComputedRef for ms (#2337)