| name | GitHub REST API Paginator Library |
| slug | github-rest-api-paginator-library |
| description | Provides a typed pagination wrapper for the GitHub REST API using Octokit.js and the @octokit/plugin-paginate-rest plugin. Handles Link header parsing, rate limit detection via X-RateLimit-Remaining, and automatic retry with exponential backoff. Supports listing issues, pull requests, commits, and workflow runs with async iterator patterns. |
| github_stars | 58 |
| verification | security_reviewed |
| source | https://github.com/octokit/plugin-paginate-rest.js |
| author | Octokit |
| category | Library & API Reference |
| framework | Codex |
| tool_ecosystem | {"github_repo":"octokit/plugin-paginate-rest.js","github_stars":58,"npm_package":"@octokit/plugin-paginate-rest","npm_weekly_downloads":26656585} |
GitHub REST API Paginator Library
Provides a typed pagination wrapper for the GitHub REST API using Octokit.js and the @octokit/plugin-paginate-rest plugin. Handles Link header parsing, rate limit detection via X-RateLimit-Remaining, and automatic retry with exponential backoff. Supports listing issues, pull requests, commits, and workflow runs with async iterator patterns.
Installation
Requirements and caveats from upstream:
- Node
- If your target runtime environments supports async iterators (such as most modern browsers and Node 10+), you can iterate through each response
- The compose* methods work just like their octokit.* counterparts described above, with the differenct that both methods require an octokit instance to be passed as first argument
Basic usage or getting-started notes: