Clarify mutation fetchPolicy options using MutationFetchPolicy union type
#8602
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
benjamn
commented
Aug 6, 2021
Comment on lines
+33
to
+37
| export type MutationFetchPolicy = Extract< | ||
| FetchPolicy, | ||
| | 'network-only' // default behavior (mutation results written to cache) | ||
| | 'no-cache' // alternate behavior (results not written to cache) | ||
| >; |
There was a problem hiding this comment.
This type is ultimately just 'network-only' | 'no-cache', but "extracting" that union from FetchPolicy (which is also just a union of strings) felt like the right thing to do to convey the code's intent.
…type. These are the changes I was suggesting in my comments on PR #8595: #8595 (review) I believe this is a backwards-compatible change, since it amounts to replacing a type that could only be `"no-cache" | undefined` with a strictly additive superset: `"network-only" | "no-cache" | undefined`. I don't expect anyone to want/need to pass `fetchPolicy: "network-only"` explicitly, but I think it makes sense to be explicit about the default `fetchPolicy` and its relationship to the `"no-cache"` alternative.
benjamn
force-pushed
the
MutationFetchPolicy
branch
from
673af3b to
83eb9d5
Compare
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.
These are the changes I was suggesting in my comments on PR #8595:
fetchPolicyoption ofuseMutation#8595 (review)I believe this addition of
MutationFetchPolicyis a backwards-compatible change, since it amounts to replacing a type that could only be"no-cache" | undefinedwith a strictly additive superset:"network-only" | "no-cache" | undefined.I don't expect anyone to want/need to pass
fetchPolicy: "network-only"explicitly, but I think it makes sense to be explicit about the default mutationfetchPolicybehavior, and its relationship to the"no-cache"alternative.