Add docs for x-nextjs-cache header #36023
Merged
Conversation
This file contains 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
ijjk
requested review from
timneutkens,
shuding,
styfle,
huozhi,
padmaia and
leerob
as code owners
styfle
reviewed
Apr 8, 2022
ijjk
commented
Apr 8, 2022
Co-authored-by: Steven <steven@ceriously.com>
styfle
reviewed
Apr 8, 2022
styfle
reviewed
Apr 8, 2022
styfle
approved these changes
Apr 8, 2022
leerob
reviewed
Apr 11, 2022
| The cache status of an image can be determined by reading the value of the `x-nextjs-cache` response header. The possible values are the following: | ||
|
|
||
| - `MISS` - the path is not in the cache (occurs at most once, on the first visit) | ||
| - `STALE` - the path is in the cache but exceeded the revalidate time so it will be updated in the background |
There was a problem hiding this comment.
I'm not understanding the revalidate time here as it relates to images.
There was a problem hiding this comment.
Images can also revalidate: https://nextjs.org/docs/api-reference/next/image#caching-behavior
There was a problem hiding this comment.
It is definitely not clear based on reading this - should we add links? Examples?
colinhacks
pushed a commit
to colinhacks/next.js
that referenced
this pull request
Apr 14, 2022
This adds documentation for the `x-nextjs-cache` header which is now exposed for ISR pages and image optimization requests to help signal the cache state. ## Documentation / Examples - [x] Make sure the linting passes by running `yarn lint` Co-authored-by: Steven <steven@ceriously.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This adds documentation for the
x-nextjs-cacheheader which is now exposed for ISR pages and image optimization requests to help signal the cache state.Documentation / Examples
yarn lint