-
Notifications
You must be signed in to change notification settings - Fork 194
Support pagination #503
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
Merged
andreasabel
merged 11 commits into
haskell-github:master
from
codedownio:per-page-query-v2
May 9, 2025
Merged
Support pagination #503
andreasabel
merged 11 commits into
haskell-github:master
from
codedownio:per-page-query-v2
May 9, 2025
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andreasabel
added a commit
that referenced
this pull request
May 9, 2025
This reverts commit 2bed394.
andreasabel
added a commit
that referenced
this pull request
May 9, 2025
This reverts commit 2bed394.
andreasabel
added a commit
that referenced
this pull request
May 9, 2025
This reverts commit dc43816.
I had to revert this PR since it did not support GHC 9.0 and below. |
andreasabel
added a commit
that referenced
this pull request
May 9, 2025
This reverts commit dc43816.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an attempt to support GitHub's pagination API.
At present, this package allows you to construct a request with
FetchCount
, which has constructorsFetchAtLeast Word
andFetchAll
. Both of these cause the library to repeatedly call the GitHub endpoint as many times as necessary to collect the desired number of items.This obscures the actual pagination API from the user. What if I want to fetch a specific page? And what if I want to access the
Link
header information returned by the GitHub API, to determine the total number of pages, next/last page links, etc.?This PR adds a new constructor to
FetchCount
calledFetchPage PageParams
.PageParams
allows you to specify thepage
and/orperPage
as integers, and you will get exactly the items you're asking for.This PR also exposes a function
parsePageLinks
, which you can use to extract the page links from an HTTP response. You can use it like this:I'd like to expose this in a nicer way at the higher levels of the API, like the
github
function. Maybe by providing agithubPaged
version that returns the response value and also aPageLinks
object. But this is serviceable enough for now. More API design suggestions are welcome!