useThrottledRefHistory

類別

狀態

導出大小

1.37 kB

上次變更

5 天前

相關

useDebouncedRefHistoryuseRefHistory

使用節流過濾器的 useRefHistory 的簡寫。

示範

原始碼

計數: 0

/
延遲 (毫秒)

歷史紀錄 (示範限制為 10 筆紀錄)

2025-03-10 03:47:04{ value: 0 }

用法

此函式會在計數器的值變更後立即取得第一個快照，第二個快照則延遲 1000 毫秒。

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

const counter = shallowRef(0)
const { history, undo, redo } = useThrottledRefHistory(counter, { deep: true, throttle: 1000 })

類型宣告

typescript

export type UseThrottledRefHistoryOptions<Raw, Serialized = Raw> = Omit<
  UseRefHistoryOptions<Raw, Serialized>,
  "eventFilter"
> & {
  throttle?: MaybeRef<number>
  trailing?: boolean
}
export type UseThrottledRefHistoryReturn<
  Raw,
  Serialized = Raw,
> = UseRefHistoryReturn<Raw, Serialized>
/**
 * Shorthand for [useRefHistory](https://vueuse.dev.org.tw/useRefHistory) with throttled filter.
 *
 * @see https://vueuse.dev.org.tw/useThrottledRefHistory
 * @param source
 * @param options
 */
export declare function useThrottledRefHistory<Raw, Serialized = Raw>(
  source: Ref<Raw>,
  options?: UseThrottledRefHistoryOptions<Raw, Serialized>,
): UseThrottledRefHistoryReturn<Raw, Serialized>