Skip to content
On this page

watchDeep

Category
Export Size
325 B
Last Changed
2 weeks ago

Shorthand for watching value with

Usage

Similar to watch, but with { deep: true }

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

const nestedObject = ref({ foo: { bar: { deep: 5 } } })

watchDeep(nestedObject, (obj) => {
  console.log(updated)
})

onMounted(() => {
  nestedObject.value.foo.bar.deep = 10
})
import { watchDeep } from '@vueuse/core'

const nestedObject = ref({ foo: { bar: { deep: 5 } } })

watchDeep(nestedObject, (obj) => {
  console.log(updated)
})

onMounted(() => {
  nestedObject.value.foo.bar.deep = 10
})

Type Declarations

typescript
export declare function watchDeep<
  T extends Readonly<MultiWatchSources>,
  Immediate extends Readonly<boolean> = false
>(
  source: T,
  cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
  options?: Omit<WatchOptions<Immediate>, "deep">
): WatchStopHandle
export declare function watchDeep<
  T,
  Immediate extends Readonly<boolean> = false
>(
  source: WatchSource<T>,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: Omit<WatchOptions<Immediate>, "deep">
): WatchStopHandle
export declare function watchDeep<
  T extends object,
  Immediate extends Readonly<boolean> = false
>(
  source: T,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: Omit<WatchOptions<Immediate>, "deep">
): WatchStopHandle
export declare function watchDeep<
  T extends Readonly<MultiWatchSources>,
  Immediate extends Readonly<boolean> = false
>(
  source: T,
  cb: WatchCallback<MapSources<T>, MapOldSources<T, Immediate>>,
  options?: Omit<WatchOptions<Immediate>, "deep">
): WatchStopHandle
export declare function watchDeep<
  T,
  Immediate extends Readonly<boolean> = false
>(
  source: WatchSource<T>,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: Omit<WatchOptions<Immediate>, "deep">
): WatchStopHandle
export declare function watchDeep<
  T extends object,
  Immediate extends Readonly<boolean> = false
>(
  source: T,
  cb: WatchCallback<T, Immediate extends true ? T | undefined : T>,
  options?: Omit<WatchOptions<Immediate>, "deep">
): WatchStopHandle

Source

SourceDocs

Contributors

Changelog

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.