Add QueryOptions and QueryBaseOptions interfaces
#3569
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
`ApolloClient.query` is currently configured to accept `WatchQueryOptions`, which means the docs show people that passing things like `pollingInterval` into `ApolloClient.query` is supported (when in reality it's only supported when using `ApolloClient.watchQuery`). These changes add a new `QueryOptions` interface, and pull some of the common options out into a parent `QueryBaseOptions` interface. `ApolloClient.query` has been updated to use the `QueryOptions` interface, which should help clear up a bit of confusion. Fixes #3395.
Generated by 🚫 dangerJS |
jbaxleyiii
reviewed
Jun 11, 2018
| @@ -672,17 +674,6 @@ export class QueryManager<TStore> { | |||
| throw new Error('returnPartialData option only supported on watchQuery.'); | |||
| } | |||
|
|
|||
| if ((options as any).pollInterval) { | |||
There was a problem hiding this comment.
@hwillson it would probably be good to still throw here for people not using typescript
There was a problem hiding this comment.
I was on the fence on this one (I removed it just before committing). My logic was that once the option is properly removed from the docs, the number of people trying to use it should be greatly reduced. Then if it is provided by accident, it will just be ignored. But I guess it doesn't hurt to be extra communicative 📣. I'll add it back - thanks @jbaxleyiii!
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.
ApolloClient.queryis currently configured to acceptWatchQueryOptions, which means the docs show people that passing things likepollingIntervalintoApolloClient.queryis supported (when in reality it's only supported when usingApolloClient.watchQuery). These changes add a newQueryOptionsinterface, and pull some of the common options out into a parentQueryBaseOptionsinterface.ApolloClient.queryhas been updated to use theQueryOptionsinterface, which should help clear up a bit of confusion.Fixes #3395.