Skip to content

watchImmediate

Category
Export Size
117 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
(
obj
, (
updated
) => {
console
.
log
(
updated
) // Console.log will be logged twice
})

Type Declarations

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

SourceDocs

Contributors

Anthony Fu
Anthony Fu
Nate Oliver
山吹色御守
jp-liu
Andrew Ferreira
Kyrie890514
Alex Liu
丶远方
Magomed Chemurziev
Hammad Asif

Changelog

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(watchDeep): unify overload declaration for watch functions (#4043)
v10.2.0 on
4b4e6 - fix: fix overload signature (#3114)
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.

FREE WEEKEND
Free access to Official Vue.js Certification Training
NOW LIVE
Start Now
32
hours
:
12
minutes
:
42
seconds
: