-
Notifications
You must be signed in to change notification settings - Fork 10.4k
Added docs for cache: no-store #17926
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| _build: | ||
| publishResources: false | ||
| render: never | ||
| list: never | ||
|
|
||
| name: "Enable `cache: no-store` HTTP standard API" | ||
| sort_date: "2024-11-11" | ||
| enabled_date: "2024-11-11" | ||
| enable_flag: "cache_option_enabled" | ||
| disable_flag: "cache_option_disabled" | ||
| --- | ||
|
|
||
| When you enable the `cache_option_enabled` compatibility flag, you can specify a value for the `cache` property of the Request interface. | ||
| When this compatibility flag is not enabled, or `cache_option_disabled` is set, the Workers runtime will throw an `Error` saying `The 'cache' field on | ||
| 'RequestInitializerDict' is not implemented.` | ||
|
|
||
| When this flag is enabled you can instruct Cloudflare not to cache the response from a subrequest you make from your Worker using the [`fetch()` API](/workers/runtime-apis/fetch/): | ||
|
|
||
| The only cache option enabled with `cache_option_enabled` is `'no-store'`. | ||
| Specifying any other value will cause the Workers runtime to throw a `TypeError` with the message `Unsupported cache mode: <the-mode-you-specified>`. | ||
|
|
||
| When `no-store` is specified: | ||
| * All requests have the headers `Pragma: no-cache` and `Cache-Control: no-cache` are set on them. | ||
|
|
||
| * Subrequests to origins not hosted by Cloudflare bypasses Cloudflare's cache. | ||
|
|
||
| Examples using `cache: 'no-store'`: | ||
|
|
||
| ```js | ||
| const response = await fetch("https://example.com", { cache: 'no-store'}); | ||
tewaro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ``` | ||
|
|
||
| The cache value can also be set on a `Request` object. | ||
|
|
||
| ```js | ||
| const request = new Request("https://example.com", { cache: 'no-store'}); | ||
| const response = await fetch(request); | ||
| ``` | ||
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add a little text about this one specifically, so it's similar to to the one below.
Maybe just: "The 'cache' have can be passed into the options for
fetch"