1---
2category: Watch
3alias: pausableWatch
4---
5 
6# watchPausable
7 
8Pausable watch
9 
10::: info
11This function will be removed in future version.
12:::
13 
14::: tip
15 
16[Pausable Watcher](https://vuejs.org/api/reactivity-core.html#watch) has been added to Vue [since 3.5](https://github.com/vuejs/core/pull/9651), use `const { stop, pause, resume } = watch(watchSource, callback)` instead.
17 
18:::
19 
20## Usage
21 
22Use as normal the `watch`, but return extra `pause()` and `resume()` functions to control.
23 
24```ts
25import { watchPausable } from '@vueuse/core'
26import { nextTick, shallowRef } from 'vue'
27 
28const source = shallowRef('foo')
29 
30const { stop, pause, resume } = watchPausable(
31  source,
32  v => console.log(`Changed to ${v}!`),
33)
34 
35source.value = 'bar'
36await nextTick() // Changed to bar!
37 
38pause()
39 
40source.value = 'foobar'
41await nextTick() // (nothing happend)
42 
43resume()
44 
45source.value = 'hello'
46await nextTick() // Changed to hello!
47```
48 
49## Type Declarations
50 
51```ts
52export interface WatchPausableReturn extends Pausable {
53  stop: WatchStopHandle
54}
55export type WatchPausableOptions<Immediate> =
56  WatchWithFilterOptions<Immediate> & PausableFilterOptions
57/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
58export declare function watchPausable<
59  T extends Readonly<MultiWatchSources>,
60  Immediate extends Readonly<boolean> = false,
61>(
62  sources: [...T],
63  cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
64  options?: WatchPausableOptions<Immediate>,
65): WatchPausableReturn
66/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
67export declare function watchPausable<
68  T,
69  Immediate extends Readonly<boolean> = false,
70>(
71  source: WatchSource<T>,
72  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
73  options?: WatchPausableOptions<Immediate>,
74): WatchPausableReturn
75/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
76export declare function watchPausable<
77  T extends object,
78  Immediate extends Readonly<boolean> = false,
79>(
80  source: T,
81  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
82  options?: WatchPausableOptions<Immediate>,
83): WatchPausableReturn
84/** @deprecated Use Vue's built-in `watch` instead. This function will be removed in future version. */
85export declare const pausableWatch: typeof watchPausable
86```
87