question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Make breaking API changes to align with docs

See original GitHub issue

When I was writing the docs, I decided to write them for the API I want, not the one I have 😛

So we should make some changes to the library itself to bring it up to date:

  • Make ApolloClient a default export of the package
  • Make the arguments to ApolloClient an object instead of positional
  • Make sure ApolloClient#query doesn’t take a returnPartialResults option
  • Add a few more functions to WatchedQueryHandle

@jbaxleyiii @johnthepink heads up, these are definitely breaking changes. Let me know if you disagree with any of them. You can see the docs for examples of how it would look: https://apollostack.gitbooks.io/apollo-client/content/

Issue Analytics

  • State:closed
  • Created 7 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
jbaxleyiiicommented, Apr 8, 2016

Perhaps by default, we should just assume the server doesn’t support the Relay Node spec, and just check if we have all of the query results on the client.

@stubailo I think this sounds great

0reactions
stubailocommented, Apr 8, 2016

Perhaps by default, we should just assume the server doesn’t support the Relay Node spec, and just check if we have all of the query results on the client. Then we can set forceFetch to false, and it will help a lot for stuff like navigating to a route you just visited.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to handle an API breaking change - Devoteam S Platform
A breaking change can be as small as a new mandatory field or as big as existing resources and data types being renamed/removed...
Read more >
Breaking changes - GitHub Docs
Any breaking changes will be released in a new API version. Breaking changes are changes that can potentially break an integration. Breaking ......
Read more >
Versioning | Cloud APIs - Google Cloud
Sometimes it is necessary to make backwards-incompatible (or "breaking") changes to an API. These kinds of changes can cause issues or breakage for...
Read more >
Upcoming Breaking Changes to the Transmissions API
Usually, these objectives are aligned, but there are times when moving the API forward require an unavoidable breaking change.
Read more >
REST Resource: documents | Google Docs
A TextStyle that only includes the changes made in this suggestion. ... A page break makes the subsequent text start at the top...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found