refDebounced

参考值的去抖动执行。

¥Debounce execution of a ref value.

示例

源代码演练场

Delay is set to 1000ms for this demo.

Debounced:

Times Updated: 0

用法

¥Usage

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'

一个使用对象引用的示例。

¥An example with object ref.

import { refDebounced } from '@vueuse/core'
import { shallowRef } from 'vue'

const data = shallowRef({
  name: 'foo',
  age: 18,
})
const debounced = refDebounced(data, 1000)

function update() {
  data.value = {
    ...data.value,
    name: 'bar',
  }
}

console.log(debounced.value) // { name: 'foo', age: 18 }
update()
await sleep(1100)

console.log(debounced.value) // { name: 'bar', age: 18 }

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

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

推荐阅读

¥Recommended Reading

• 去抖与油门：最终视觉指南

  ¥Debounce vs Throttle: Definitive Visual Guide

类型声明

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

源代码

源代码 • 示例 • 文档

变更日志

最近没有更改