Skip to content

watchImmediate ​

Category
Export Size
322 B
Last Changed
9 months ago

Shorthand for watching value with {immediate: true}

Usage ​

Similar to watch, but with { immediate: true }

ts
import { watchImmediate } from '@vueuse/core'

const obj = ref('vue-use')

// changing the value from some external store/composables
obj.value = 'VueUse'

watchImmediate(nestedObject, (obj) => {
  console.log(updated) // Console.log will be logged twice
})

Type Declarations ​

typescript
export declare function watchImmediate<T extends Readonly<MultiWatchSources>>(
  source: T,
  cb: WatchCallback<MapSources<T>, MapOldSources<T, true>>,
  options?: Omit<WatchOptions<true>, "immediate">,
): WatchStopHandle
export declare function watchImmediate<T>(
  source: WatchSource<T>,
  cb: WatchCallback<T, T | undefined>,
  options?: Omit<WatchOptions<true>, "immediate">,
): WatchStopHandle
export declare function watchImmediate<T extends object>(
  source: T,
  cb: WatchCallback<T, T | undefined>,
  options?: Omit<WatchOptions<true>, "immediate">,
): WatchStopHandle

Source ​

Source • Docs

Contributors ​

Anthony Fu
Andrew Ferreira
Kyrie890514
Alex Liu
丶远方
Magomed Chemurziev
Hammad Asif

Changelog ​

v10.2.0 on 6/16/2023
4b4e6 - fix: fix overload signature (#3114)
v10.1.0 on 4/22/2023
8f6a0 - feat(watch): watchImmediate and watchDeep support overloads (#2998)
v10.0.0-beta.3 on 4/12/2023
e6e25 - fix(watchDeep,watchImmediate): fix callback function execution logic (#2951)
v10.0.0-beta.0 on 3/14/2023
b4ec7 - feat(watch): shorthands for watch (#2651)

Released under the MIT License.