apollographql / apollo-client

:rocket:  A fully-featured, production ready caching GraphQL client for every UI framework and GraphQL server.
https://apollographql.com/client
MIT License
19.34k stars 2.66k forks source link

Documentataion: mutaitonHookOptions.ignoreResults requires additional clarification #11950

Open ksdc-grantw opened 2 months ago

ksdc-grantw commented 2 months ago

The documentation for the UseMutation Option ignoreResults (see here) only states that the "data property is not updated with the mutation's result".

It does not indicate that the loading state of the requests is also not updated. Please can you update the docs to include this clarification.

Thanks, Grant

phryneas commented 2 months ago

That's a good callout - in fact, ignoreResults will cause the hook to ignore all information about the running mutation. Do you want to open a PR against our documentation? It would be greatly appreciated.