fargo
1a822493ba
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.
1.6 KiB
1.6 KiB
category, alias
| category | alias |
|---|---|
| Watch | throttledWatch |
watchThrottled
Throttled watch.
Usage
Similar to watch, but offering an extra option throttle which will be applied to the callback function.
import { watchThrottled } from '@vueuse/core';
watchThrottled(
source,
() => {
console.log('changed!');
},
{ throttle: 500 },
);
It's essentially a shorthand for the following code:
import { throttleFilter, watchWithFilter } from '@vueuse/core';
watchWithFilter(
source,
() => {
console.log('changed!');
},
{
eventFilter: throttleFilter(500),
},
);
Type Declarations
export interface WatchThrottledOptions<Immediate> extends WatchOptions<Immediate> {
throttle?: MaybeRefOrGetter<number>;
trailing?: boolean;
leading?: boolean;
}
export declare function watchThrottled<
T extends Readonly<MultiWatchSources>,
Immediate extends Readonly<boolean> = false,
>(
sources: [...T],
cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
options?: WatchThrottledOptions<Immediate>,
): WatchHandle;
export declare function watchThrottled<T, Immediate extends Readonly<boolean> = false>(
source: WatchSource<T>,
cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
options?: WatchThrottledOptions<Immediate>,
): WatchHandle;
export declare function watchThrottled<
T extends object,
Immediate extends Readonly<boolean> = false,
>(
source: T,
cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
options?: WatchThrottledOptions<Immediate>,
): WatchHandle;
/** @deprecated use `watchThrottled` instead */
export declare const throttledWatch: typeof watchThrottled;