Update the createWithCache
docs to warn about caching errors
#2373
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.
WHY are these changes introduced?
In the
createWithCache
callback, if the user does not throw when a 3p request fails, the result will be cached. This PR adds a warning to the docs.HOW to test your changes?
Guide changes - https://shopify-dev.shopify-dev-68tf.bret-little.us.spin.dev/docs/storefronts/headless/hydrogen/data-fetching/third-party#step-1-create-a-new-third-party-api-client
Reference docs changes - https://shopify-dev.shopify-dev-68tf.bret-little.us.spin.dev/docs/api/hydrogen/2024-07/utilities/caching/createwithcache
Post-merge steps
Checklist