コンテンツにスキップ

refDebounced

カテゴリ
エクスポートサイズ
423 B
最終変更日
先週
エイリアス
useDebouncedebouncedRef
関連

ref値の実行をデバウンスします。

デモ

このデモでは、遅延は1000msに設定されています。

デバウンス済み

更新回数: 0

使用方法

js
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'

オプションの3番目のパラメータとしてmaxWaitオプションを含むこともできます。詳細は`useDebounceFn`を参照してください。

型宣言

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 useDebounce, refDebounced as debouncedRef }

ソース

ソースデモドキュメント

貢献者

Anthony Fu
Anthony Fu
Dominik Klein

変更履歴

v12.0.0-beta.1 2024/11/21
0a9ed - feat!: Vue 2 サポートの削除、バンドルの最適化、クリーンアップ (#4349)
v10.0.0-beta.4 2023/4/13
4d757 - feat(types)!: `MaybeComputedRef` から `MaybeRefOrGetter` に名前変更
v9.4.0 2022/10/25
ce3dc - feat: ms に MaybeComputedRef を使用 (#2337)

MITライセンスでリリースされています。