Skip to content

Commit 6b1b335

Browse files
committed
updated readme
1 parent 856eae6 commit 6b1b335

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,11 +231,15 @@ Relay [specification for mutations](https://facebook.github.io/relay/graphql/mut
231231

232232
You can use `@GraphQLConnection` annotation to make a field iterable in adherence to Relay [Connection specification](https://facebook.github.io/relay/graphql/connections.htm).\
233233
If a field is annotated with the annotation, the associated dataFetcher must return an instance of `PaginatedData`.\
234-
The `PaginatedData` class holds the result of the conneciton:
234+
The `PaginatedData` class holds the result of the connection:
235235
1. The data of the page
236236
2. Whether or not there is a next page and a previous page
237237
3. A method that returns for each entity the encoded cursor of the entity (it returns string)
238238

239+
If you want to use you own implementation of connection, that's fine, just give a value to connection().\
240+
Please note that if you do so, you also have to specify your own connection validator that implements `ConnectionValidator`\
241+
(and should throw `@GraphQLConnectionException` if something is wrong)
242+
239243
NOTE: because `PropertyDataFetcher` and `FieldDataFetcher` can't handle connection, this annotation cant be used on a field that doesn't have a dataFetcher
240244

241245
### Customizing Relay schema

0 commit comments

Comments
 (0)