Browse Source

Merge pull request #671 from khier996/improve-cursor-based-pagination-docs

improve documentation for cursor based pagination
Tim Anema 5 years ago
parent
commit
6b25728e4e
1 changed files with 8 additions and 0 deletions
  1. 8 0
      README.md

+ 8 - 0
README.md

@@ -403,6 +403,14 @@ while products.next_page?
 end
 end
 ```
 ```
 
 
+If you want cursor based pagination to work across page loads, or want to distribute workload across multiple background jobs, you can use #next_page_info or #previous_page_info methods that return strings:
+
+```
+  first_batch_products = ShopifyAPI::Product.find(:all, params: { limit: 50 })
+  second_batch_products = ShopifyAPI::Product.find(:all, params: { limit: 50, page_info: first_batch_products.next_page_info })
+  ...
+```
+
 Relative cursor pagination is currently available for all endpoints using the `2019-10` and later API versions.
 Relative cursor pagination is currently available for all endpoints using the `2019-10` and later API versions.
 
 
 ## Using Development Version
 ## Using Development Version