Skip to content

watchDeep

Category
Export Size
113 B
Last Changed
yesterday

Shorthand for watching value with {deep: true}

Usage

Similar to watch, but with { deep: true }

ts
import { 
watchDeep
} from '@vueuse/core'
const
nestedObject
=
ref
({
foo
: {
bar
: {
deep
: 5 } } })
watchDeep
(
nestedObject
, (
updated
) => {
console
.
log
(
updated
)
})
onMounted
(() => {
nestedObject
.
value
.
foo
.
bar
.
deep
= 10
})

Type Declarations

ts
export declare function 
watchDeep
<
T
extends
Readonly
<
WatchSource
<unknown>[]>,
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

Anthony Fu
Anthony Fu
Arthur Darkstone
山吹色御守
jp-liu
Kyrie890514
Alex Liu
丶远方
Hammad Asif

Changelog

Pending for release...
00a72 - fix(types): update type casting for watch functions to use WatchSource (#4966)
v12.0.0-beta.1 on
0a9ed - feat!: drop Vue 2 support, optimize bundles and clean up (#4349)
v11.0.0-beta.2 on
0716d - fix: unify overload declaration for watch functions (#4043)
v10.1.0 on
8f6a0 - feat(watch): watchImmediate and watchDeep support overloads (#2998)
v10.0.0-beta.3 on
e6e25 - fix(watchDeep,watchImmediate): fix callback function execution logic (#2951)

Released under the MIT License.

Join the Biggest FREE AI-Driven Development Event for Vue Developers
Save My Seat