docs: add updateTag example to cacheTag page#94508
Merged
Merged
Conversation
Contributor
Tests PassedCommit: e465ff9 |
Contributor
Stats skippedCommit: e465ff9 |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an updateTag usage example to the cacheTag API reference to steer readers toward immediate, read-your-own-writes invalidation for user-triggered mutations (e.g. forms), complementing the existing revalidateTag example.
Changes:
- Adds a new documentation example showing
updateTag('my-data')in a'use server'function. - Introduces a short explanatory paragraph describing when to prefer
updateTagoverrevalidateTag.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
icyJoseph
force-pushed
the
aurorascharff/cachetag-updatetag-docs
branch
from
7c4784b to
81cfe13
Compare
icyJoseph
approved these changes
Jun 8, 2026
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
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.
What?
Adds an
updateTagexample to thecacheTagAPI reference page.Why?
The
cacheTagdocs only showedrevalidateTagfor cache invalidation. For forms and user-triggered mutations (the dominant use case forcacheTag),updateTagis the recommended API because it provides read-your-own-writes semantics. DX agent friction logs showed agents defaulting torevalidateTagand hitting the deprecated single-arg error before discoveringupdateTagvia web search.How?
Added a second example block after the existing
revalidateTagone, showingupdateTag('my-data')in a Server Function.