Allow manual pagination of API results #69
Closed
Conversation
This file contains 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
|
I have added the docs now. I am looking forward to your feedback ;-) |
Closed
|
Further edits: #72 |
|
Nice. Thank you for reviewing and merging ;-) |
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.
Currently it is not able to paginate the results of the API manually. The
Paginationtrait always iterates over all pages automatically, which is not always desired. I have already created the issue #68.In my case for example, I want to synchronize a custom member list (see this repo interactively via cli command. I want to compare each person and show the differences between the local and the remote data.
The user should be able to exit the comparison. This is why it would be useless to fetch hundreds of data records if only maybe 10 are needed.
The change is very simple. The pagination trait will check if the options contains a specific page. If any is set it will only load this specific page. Otherwise it will fall back to the previois behaviour and iterate over all pages. So backward compatibility is kept ;-)
I am going to add an explanation to the documentation, too. Aferwards I'll update this PR.