Fix type of cursor argument in PaginationContainer example #1733
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
According to the GraphQL Connection documentation, the `cursor` argument should be a `String` type instead of `ID`: https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor This fixes errors that arise from using the example as inspiration such as: `Variable "$cursor" of type "ID" used in position expecting type "String".`
|
@kassens has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator. |
|
Thanks! |
This was referenced Nov 18, 2020
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.
According to the GraphQL Connection documentation, the implied default type of
cursorargument isString:https://facebook.github.io/relay/graphql/connections.htm#sec-Cursor
While other types are possible, I think it might be best to default to String as most implementations default to
Stringtype and it would greatly help newcomers who likely are using these implementations.Otherwise, many will encounter the following error:
Variable "$cursor" of type "ID" used in position expecting type "String".See implementations where String type is implemented as default:
GraphQL Ruby
GraphQL Relay JS
GraphQL Python
Sangria GrapHQL for Scala