watchPausable
Pausable watch
Demo
Type something below to trigger the watch
Log
Usage
Use as normal the watch, but return extra pause() and resume() functions to control.
import { watchPausable } from '@vueuse/core'
import { nextTick, ref } from 'vue'
const source = ref('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!
import { watchPausable } from '@vueuse/core'
import { nextTick, ref } from 'vue'
const source = ref('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 declare function watchPausable<
T extends Readonly<WatchSource<unknown>[]>,
Immediate extends Readonly<boolean> = false
>(
sources: [...T],
cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
options?: WatchWithFilterOptions<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?: WatchWithFilterOptions<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?: WatchWithFilterOptions<Immediate>
): WatchPausableReturn
export { watchPausable as pausableWatch }
export interface WatchPausableReturn extends Pausable {
stop: WatchStopHandle
}
export declare function watchPausable<
T extends Readonly<WatchSource<unknown>[]>,
Immediate extends Readonly<boolean> = false
>(
sources: [...T],
cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
options?: WatchWithFilterOptions<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?: WatchWithFilterOptions<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?: WatchWithFilterOptions<Immediate>
): WatchPausableReturn
export { watchPausable as pausableWatch }
Source
Contributors
Anthony Fu
lvjiaxuan