Skip to content

Commit 034b789

Browse files
committed
Clarify what the cursor contains in the readme
1 parent 4f194ca commit 034b789

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Cursor pagination was made popular by GraphQL, and this library conforms to the
1515

1616
- First you specify the sort config. This contains a list of field names with their orders. It must contain a unique key.
1717
- Then you request how many items you would like to fetch with `first`.
18-
- Each item you get back also contains an opaque string cursor. The cursor is an encrypted string that contains the sort config along with the value of each field in the sort config.
18+
- Each item you get back also contains an opaque string cursor. The cursor is an encrypted string that contains the names of the fields in the sort config, alongside their values.
1919
- To fetch the next set of items you make a new request with `first` and `afterCursor` being the cursor of the last item you received.
2020

2121
If you want to fetch items in reverse order you can use `last` and `beforeCursor` instead.

0 commit comments

Comments
 (0)