Files
stack/packages/mosaic/framework/skills/vueuse-functions/references/useThrottledRefHistory.md
T
fargo 1a822493ba format: apply repo prettier (3.8.1) to the folded skills tree
963 markdown files reformatted with the repository's pinned prettier so
pnpm format:check covers the folded tree like every other repo file.

The formatter's embedded-language pass also normalized code fences
(TS semicolons, closed HTML tags in examples, lowercased CSS hex colors,
one renumbered list that skipped an index). Alphanumeric token deltas vs
the fold commit were audited file-by-file; all are formatter-equivalent
markup normalizations plus the four sanitized skills.
2026-08-19 14:37:17 -05:00

1.2 KiB

category, related
category related
State useDebouncedRefHistory, useRefHistory

useThrottledRefHistory

Shorthand for useRefHistory with throttled filter.

Usage

This function takes the first snapshot right after the counter's value was changed and the second with a delay of 1000ms.

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

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

Type Declarations

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.org/useRefHistory) with throttled filter.
 *
 * @see https://vueuse.org/useThrottledRefHistory
 * @param source
 * @param options
 */
export declare function useThrottledRefHistory<Raw, Serialized = Raw>(
  source: Ref<Raw>,
  options?: UseThrottledRefHistoryOptions<Raw, Serialized>,
): UseThrottledRefHistoryReturn<Raw, Serialized>;