Skip to content

Commit

Permalink
Adding usage note to pagination docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BobaFetters committed Jul 10, 2024
1 parent 100ad75 commit 1aa720c
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/source/pagination/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ Apollo Pagination provides a convenient and easy way to interact with and watch

Apollo Pagination provides two classes to interact with paginated endpoints: `GraphQLQueryPager` and `AsyncGraphQLQueryPager`. They have very similar APIs, but the latter supports `async`/`await` for use in asynchronous contexts.

> Apollo Pagination is its own Swift Package, in order to use the pagination functionality you will need to include the [apollo-ios-pagination](https://github.com/apollographql/apollo-ios-pagination) SPM package in your project along with [apollo-ios](https://github.com/apollographql/apollo-ios)
## Using a `GraphQLQueryPager`

The `GraphQLQueryPager` class is intended to be a simple, flexible, and powerful way to interact with paginated data. While it has a standard initializer, it is recommended to use the convenience initializers, which simplify the process of creating a `GraphQLQueryPager` instance.
Expand Down

0 comments on commit 1aa720c

Please sign in to comment.