Skip to content

watchPausable ​

Category
Last Changed
2025-08-01
Alias
pausableWatch

Pausable watch

TIP

Pausable Watcher has been added to Vue since 3.5, use const { stop, pause, resume } = watch(watchSource, callback) instead on supported versions.

Demo ​

Type something below to trigger the watch


Log

Usage ​

Use as normal the watch, but return extra pause() and resume() functions to control.

ts
import { watchPausable } from 'comuse-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!

Source ​

Source • Demo • Docs

Changelog ​

No recent changes

Released under the MIT License.