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.
2.1 KiB
2.1 KiB
category, alias
| category | alias |
|---|---|
| Watch | pausableWatch |
watchPausable
Pausable watch
::: info This function will be removed in future version. :::
::: tip
Pausable Watcher has been added to Vue since 3.5, use const { stop, pause, resume } = watch(watchSource, callback) instead.
:::
Usage
Use as normal the watch, but return extra pause() and resume() functions to control.
import { watchPausable } from '@vueuse/core';
import { nextTick, shallowRef } from 'vue';
const source = shallowRef('foo');
const { stop, pause, resume } = watchPausable(source, (v) => console.log(`Changed to ${v}!`));
source.value = 'bar';
await nextTick(); // Changed to bar!
pause();
source.value = 'foobar';
await nextTick(); // (nothing happend)
resume();
source.value = 'hello';
await nextTick(); // Changed to hello!
Type Declarations
export interface WatchPausableReturn extends Pausable {
stop: WatchStopHandle;
}
export type WatchPausableOptions<Immediate> = WatchWithFilterOptions<Immediate> &
PausableFilterOptions;
/**
* @deprecated This function will be removed in future version.
*/
export declare function watchPausable<
T extends Readonly<MultiWatchSources>,
Immediate extends Readonly<boolean> = false,
>(
sources: [...T],
cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
options?: WatchPausableOptions<Immediate>,
): WatchPausableReturn;
export declare function watchPausable<T, Immediate extends Readonly<boolean> = false>(
source: WatchSource<T>,
cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
options?: WatchPausableOptions<Immediate>,
): WatchPausableReturn;
export declare function watchPausable<
T extends object,
Immediate extends Readonly<boolean> = false,
>(
source: T,
cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
options?: WatchPausableOptions<Immediate>,
): WatchPausableReturn;
/** @deprecated use `watchPausable` instead */
export declare const pausableWatch: typeof watchPausable;