Make dataId parameter of cache.modify optional. #6178
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
Most importantly, this change allows callers of cache.modify to avoid passing "ROOT_QUERY" as the ID for modifications of root Query data. Making the dataId parameter optional and moving it after the modifiers parameter felt much more idomatic and understandable than than trying to support two conflicting type signatures for the modify method, even though that extra effort could have avoided the breaking change. Please remember that the cache.modify API was added in @apollo/client@3.0.0-beta.34 by PR #5909, so it has never been out of beta testing, so breaking changes are still fair game.
|
Just published these changes to npm in |
|
@benjamn just a reminder that the docs on the website still shows the old style: https://www.apollographql.com/docs/react/v3.0-beta/data/local-state/#local-resolvers Would be great if it could be updated 👍 |
|
Oh, I had missed that the API had been removed... We are using this quite heavily so looking forward to see what the revamp brings! 👏 |
This was referenced May 26, 2020
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.
Most importantly, this change allows callers of
cache.modify(#5909) to avoid passing"ROOT_QUERY"as the ID for modifications of root Query data.Making the
dataIdparameter optional and moving it after themodifiersparameter felt much more idiomatic and understandable than than trying to support two conflicting type signatures for themodifymethod, even though that extra effort could have avoided the breaking change.Please remember that the
cache.modifyAPI was added relatively recently in@apollo/client@3.0.0-beta.34by PR #5909, so it has never been out of beta testing, so breaking changes like this are still fair game.