React-apollo: withMutation/withSubscription/withQuery HOCs are undocumented

Created on 11 Apr 2019  路  5Comments  路  Source: apollographql/react-apollo

The document-type-specific HOCs that graphql() delegates to (withMutation, withSubscription, withQuery) are currently undocumented but are exported and thus part of the public API; reading the source to graphql() makes their role clear, but someone who encounters these HOCs in use and wants to look them up in the docs could be confused, since they're undocumented, and google results for terms like "react-apollo withMutation" are also ambiguous.

Most helpful comment

I'm not sure it's correct to close unresolved issues.

All 5 comments

If anyone wants to work on a docs PR to correct this, we'll get it in. Thanks!

I'm not sure it's correct to close unresolved issues.

@slikts Issues in the repo are now intended to only be used for bugs. This isn't a bug (not documenting these was originally intentional), so it was closed. We're managing feature requests over in https://github.com/apollographql/apollo-feature-requests if you're interested in migrating this issue over there.

This issue pops up on Google when searching for its docs.

The hooks are documented here:
https://www.apollographql.com/docs/react/essentials/mutations/

Stumbled upon this while trying to search for withQuery documentation.

I need to execute a query manually on user interaction without hooks.
hook approach: https://www.apollographql.com/docs/react/essentials/queries/#executing-queries-manually

Was this page helpful?
0 / 5 - 0 ratings