docs(types): document query argument in graphql interface #60
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
The jsdoc for the `graphql(query, options)` method overload specified the first argument as a route, when it's really a GraphQL query. This updates the documentation to reflect that. This also adds a line to the `graphql(options)` method overload that specifies that the GraphQL query must be specified in the `options` parameter.
gr2m
approved these changes
Oct 10, 2019
|
just fyi, I changed the commit to |
|
🎉 This PR is included in version 4.2.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
Oh awesome, thanks so much @gr2m! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The jsdoc for the
graphql(query, options)method overload specified thefirst argument as a route, when it's really a GraphQL query. This
updates the documentation to reflect that.
This also adds a line to the
graphql(options)method overload thatspecifies that the GraphQL query must be specified in the
optionsparameter. If that's superfluous or could be documented better I'm happy to change it.
Closes #49