Document setVariables internal API status
#3692
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
ghost
added
the
This clarifies `setVariables` as for internal use only because it has a severe caveat where a result coming from cache will not notify subscribers. That makes it a poor choice for most common use cases. Instead `refetch` should be used and is now documented as such. Also clarifies that `watchQuery` does not watch the result, but the cache store, meaning that if the store does not change, the subcribers will not be notified. In practice that means that a result coming from cache will never be seen by subscribers. This partially address apollographql#2712
PowerKiKi
force-pushed
the
issue-2712-bis
branch
from
8bf4bd0
to
adc22f9
Compare
hwillson
approved these changes
Jul 30, 2018
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 clarifies
setVariablesas for internal use only because it hasa severe caveat where a result coming from cache will not notify subscribers.
That makes it a poor choice for most common use cases.
Instead
refetchshould be used and is now documented as such.Also clarifies that
watchQuerydoes not watch the result, but the cache store,meaning that if the store does not change, the subcribers will not be notified.
In practice that means that a result coming from cache will never be seen by
subscribers.
This partially address #2712
Checklist: