Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding usage note to "Pagination Introduction" docs #424

Merged
merged 1 commit into from
Jul 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading