Immediate watchers with the Composition API #2144
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add `Eager Watchers` section to composition side
✅ Deploy Preview for vuejs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Closed
yyx990803
approved these changes
Jan 8, 2023
|
|
||
| ```js | ||
| watch(source, (newValue, oldValue) => { | ||
| // ... |
There was a problem hiding this comment.
We should add a bit of descriptive comment here, e.g. executed immediately, then again when source changes...
Otherwise LGTM
Abdelaziz18003
referenced
this pull request
in vuejs-translations/docs-ar
Jan 11, 2023
* Update: watchers.md Add `Eager Watchers` section to composition side * docs: returns consideration * Reword the section on watchEffect Co-authored-by: Johnny Charcosset <[email protected]> Co-authored-by: Johnny Charcosset <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR #2069 attempted to introduce a section in the watcher docs about using
immediate: truewith the Composition API. The new additions were fine, but they posed a problem. The existing section aboutwatchEffect()is built on the premise that it is the way to create an eager watcher. This no longer made sense when it followed a section aboutimmediate: true.This PR includes the original 2 commits from #2069, adding docs for
immediate: true. These are closely based on the existing section aboutimmediate: truewith the Options API.In addition, I've reworked the section about
watchEffect()to avoid presenting it as just a form of eager watcher. I've changed the main example in that section to something a bit more realistic, though it is still similar to the old example. Most importantly, the previous example wasn't usingimmediate: true, which doesn't really make sense if we've just introducedimmediate: truein the previous section. I've also tried to explain the benefits ofwatchEffect()a bit more explicitly, as I don't think it's obvious just from looking at the example.