refDebounced

类别

Reactivity

导出体积

451 B

上次更改

4 months ago

别名

useDebouncedebouncedRef

示例

源码 playground (beta)

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

Debounced:

更新次数: 0

用法

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'

一个带有对象引用的示例。

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。

类型声明

typescript

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