npmpackage.info

Gathering detailed insights and metrics for @octokit/plugin-paginate-rest

Other packages similar to @octokit/plugin-paginate-rest

@ptomulik/octokit-paginate-rest-limit

1.1.4

Limit function for @octokit/plugin-paginate-rest

Gathering detailed insights and metrics for @octokit/plugin-paginate-rest

@octokit/plugin-paginate-rest - 13.0.0 | npmpackage.info

@octokit/plugin-paginate-rest

Octokit plugin to paginate REST API endpoint responses

13.0.0

MIT

TypeScript

176.14 kB

1,518,307,664 7.5

Installations

npm install @octokit/plugin-paginate-rest

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>= 20

Node Version

22.15.0

NPM Version

10.9.2 Score

Supply Chain

99.6

Quality

90.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

2

Total

637

Closed

30

Merged

605

Issues

Open

5

Total

43

Closed

38

Releases

124

v13.0.0

Updated on May 20, 2025

v12.0.0

Updated on Apr 10, 2025

v11.6.0

Updated on Mar 18, 2025

v11.5.0

Updated on Mar 18, 2025

v11.4.4-cjs.2

Updated on Feb 26, 2025

v11.4.4-cjs.1

Updated on Feb 26, 2025

View All 124 releases

Languages

TypeScript

JavaScript

TypeScript (95.49%)

JavaScript (4.51%)

Developer

octokit

Download Statistics

Total Downloads

1,518,307,664

Last Day

2,218,493

Last Week

12,607,781

Last Month

51,052,736

Last Year

497,307,611

GitHub Statistics

MIT License

52 Stars

740 Commits

27 Forks

7 Watchers

8 Branches

23 Contributors

Updated on May 21, 2025

Maintainers

View All 23 Contributors

Package Meta Information

Latest Version

13.0.0

Package Id

@octokit/plugin-paginate-rest@13.0.0

Unpacked Size

176.14 kB

Size

19.78 kB

File Count

NPM Version

10.9.2

Node Version

22.15.0

Published on

May 20, 2025

Total Downloads

Cumulative downloads

Total Downloads

1,518,307,664

Last Day

4.2%

2,218,493

Compared to previous day

Last Week

5.5%

12,607,781

Compared to previous week

Last Month

3.1%

51,052,736

Compared to previous month

Last Year

36.1%

497,307,611

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

plugin-paginate-rest.js

Octokit plugin to paginate REST API endpoint responses

Usage

Browsers

Browsers	Load `@octokit/plugin-paginate-rest` and `@octokit/core` (or core-compatible module) directly from esm.sh `1<script type="module"> 2 import { Octokit } from "https://esm.sh/@octokit/core"; 3 import { 4 paginateRest, 5 composePaginateRest, 6 } from "https://esm.sh/@octokit/plugin-paginate-rest"; 7</script>`
Node	Install with `npm install @octokit/core @octokit/plugin-paginate-rest`. Optionally replace `@octokit/core` with a core-compatible module `1import { Octokit } from "@octokit/core"; 2import { 3 paginateRest, 4 composePaginateRest, 5} from "@octokit/plugin-paginate-rest";`

Load @octokit/plugin-paginate-rest and @octokit/core (or core-compatible module) directly from esm.sh

1<script type="module">
2  import { Octokit } from "https://esm.sh/@octokit/core";
3  import {
4    paginateRest,
5    composePaginateRest,
6  } from "https://esm.sh/@octokit/plugin-paginate-rest";
7</script>

Node

Install with npm install @octokit/core @octokit/plugin-paginate-rest. Optionally replace @octokit/core with a core-compatible module

1import { Octokit } from "@octokit/core";
2import {
3  paginateRest,
4  composePaginateRest,
5} from "@octokit/plugin-paginate-rest";

1const MyOctokit = Octokit.plugin(paginateRest);
2const octokit = new MyOctokit({ auth: "secret123" });
3
4// See https://developer.github.com/v3/issues/#list-issues-for-a-repository
5const issues = await octokit.paginate("GET /repos/{owner}/{repo}/issues", {
6  owner: "octocat",
7  repo: "hello-world",
8  since: "2010-10-01",
9  per_page: 100,
10});

If you want to utilize the pagination methods in another plugin, use composePaginateRest.

1function myPlugin(octokit, options) {
2  return {
3    allStars({owner, repo}) => {
4      return composePaginateRest(
5        octokit,
6        "GET /repos/{owner}/{repo}/stargazers",
7        {owner, repo }
8      )
9    }
10  }
11}

[!IMPORTANT] As we use conditional exports, you will need to adapt your tsconfig.json. See the TypeScript docs on package.json "exports".

`octokit.paginate()`

The paginateRest plugin adds a new octokit.paginate() method which accepts the same parameters as octokit.request. Only "List ..." endpoints such as List issues for a repository are supporting pagination. Their response includes a Link header. For other endpoints, octokit.paginate() behaves the same as octokit.request().

The per_page parameter is usually defaulting to 30, and can be set to up to 100, which helps retrieving a big amount of data without hitting the rate limits too soon.

An optional mapFunction can be passed to map each page response to a new value, usually an array with only the data you need. This can help to reduce memory usage, as only the relevant data has to be kept in memory until the pagination is complete.

1const issueTitles = await octokit.paginate(
2  "GET /repos/{owner}/{repo}/issues",
3  {
4    owner: "octocat",
5    repo: "hello-world",
6    since: "2010-10-01",
7    per_page: 100,
8  },
9  (response) => response.data.map((issue) => issue.title),
10);

The mapFunction gets a 2nd argument done which can be called to end the pagination early.

1const issues = await octokit.paginate(
2  "GET /repos/{owner}/{repo}/issues",
3  {
4    owner: "octocat",
5    repo: "hello-world",
6    since: "2010-10-01",
7    per_page: 100,
8  },
9  (response, done) => {
10    if (response.data.find((issue) => issue.title.includes("something"))) {
11      done();
12    }
13    return response.data;
14  },
15);

Alternatively you can pass a request method as first argument. This is great when using in combination with @octokit/plugin-rest-endpoint-methods:

1const issues = await octokit.paginate(octokit.rest.issues.listForRepo, {
2  owner: "octocat",
3  repo: "hello-world",
4  since: "2010-10-01",
5  per_page: 100,
6});

`octokit.paginate.iterator()`

If your target runtime environments supports async iterators (such as most modern browsers and Node 10+), you can iterate through each response

1const parameters = {
2  owner: "octocat",
3  repo: "hello-world",
4  since: "2010-10-01",
5  per_page: 100,
6};
7for await (const response of octokit.paginate.iterator(
8  "GET /repos/{owner}/{repo}/issues",
9  parameters,
10)) {
11  // do whatever you want with each response, break out of the loop, etc.
12  const issues = response.data;
13  console.log("%d issues found", issues.length);
14}

Alternatively you can pass a request method as first argument. This is great when using in combination with @octokit/plugin-rest-endpoint-methods:

1const parameters = {
2  owner: "octocat",
3  repo: "hello-world",
4  since: "2010-10-01",
5  per_page: 100,
6};
7for await (const response of octokit.paginate.iterator(
8  octokit.rest.issues.listForRepo,
9  parameters,
10)) {
11  // do whatever you want with each response, break out of the loop, etc.
12  const issues = response.data;
13  console.log("%d issues found", issues.length);
14}

`composePaginateRest` and `composePaginateRest.iterator`

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

How it works

octokit.paginate() wraps octokit.request(). As long as a rel="next" link value is present in the response's Link header, it sends another request for that URL, and so on.

Most of GitHub's paginating REST API endpoints return an array, but there are a few exceptions which return an object with a key that includes the items array. For example:

Search repositories (key items)
List check runs for a specific ref (key: check_runs)
List check suites for a specific ref (key: check_suites)
List repositories for an installation (key: repositories)
List installations for a user (key installations)

octokit.paginate() is working around these inconsistencies so you don't have to worry about it.

If a response is lacking the Link header, octokit.paginate() still resolves with an array, even if the response returns a single object.

Types

The plugin also exposes some types and runtime type guards for TypeScript projects.

Types	`1import { 2 PaginateInterface, 3 PaginatingEndpoints, 4} from "@octokit/plugin-paginate-rest";`
Guards	`1import { isPaginatingEndpoint } from "@octokit/plugin-paginate-rest";`

PaginateInterface

An interface that declares all the overloads of the .paginate method.

PaginatingEndpoints

An interface which describes all API endpoints supported by the plugin. Some overloads of .paginate() method and composePaginateRest() function depend on PaginatingEndpoints, using the keyof PaginatingEndpoints as a type for one of its arguments.

1import { Octokit } from "@octokit/core";
2import {
3  PaginatingEndpoints,
4  composePaginateRest,
5} from "@octokit/plugin-paginate-rest";
6
7type DataType<T> = "data" extends keyof T ? T["data"] : unknown;
8
9async function myPaginatePlugin<E extends keyof PaginatingEndpoints>(
10  octokit: Octokit,
11  endpoint: E,
12  parameters?: PaginatingEndpoints[E]["parameters"],
13): Promise<DataType<PaginatingEndpoints[E]["response"]>> {
14  return await composePaginateRest(octokit, endpoint, parameters);
15}

isPaginatingEndpoint

A type guard, isPaginatingEndpoint(arg) returns true if arg is one of the keys in PaginatingEndpoints (is keyof PaginatingEndpoints).

1import { Octokit } from "@octokit/core";
2import {
3  isPaginatingEndpoint,
4  composePaginateRest,
5} from "@octokit/plugin-paginate-rest";
6
7async function myPlugin(octokit: Octokit, arg: unknown) {
8  if (isPaginatingEndpoint(arg)) {
9    return await composePaginateRest(octokit, arg);
10  }
11  // ...
12}

Contributing

See CONTRIBUTING.md

License

MIT

Moderate

5.3/10

Summary

@octokit/plugin-paginate-rest has a Regular Expression in iterator Leads to ReDoS Vulnerability Due to Catastrophic Backtracking

Affected Versions

>= 1.0.0, < 9.2.2

Patched Versions

9.2.2

Moderate

5.3/10

Summary

@octokit/plugin-paginate-rest has a Regular Expression in iterator Leads to ReDoS Vulnerability Due to Catastrophic Backtracking

Affected Versions

>= 9.3.0-beta.1, < 11.4.1

Patched Versions

11.4.1

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Maintained

Determines if the project is "actively maintained".

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

SAST

Determines if the project uses static code analysis.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

9

Security-Policy

Determines if the project has published a security policy.

4

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 4

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/add_to_octokit_project.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/codeql.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/immediate-response.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/immediate-response.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/release.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update-prettier.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/plugin-paginate-rest.js/update.yml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/update.yml:30
Info: 0 out of 17 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 third-party GitHubAction dependencies pinned
Info: 5 out of 6 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

Score

7.5

/10

Last Scanned on 2025-05-12

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to @octokit/plugin-paginate-rest

Other packages similar to @octokit/plugin-paginate-rest

@octokit/plugin-paginate-rest

Installations

Developer Guide

Yes

ESM

>= 20

22.15.0

10.9.2

Score

Pull Requests

2

637

30

605

Issues

5

43

38

Releases

Languages

Developer

octokit

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

1,518,307,664

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

plugin-paginate-rest.js

Usage

octokit.paginate()

octokit.paginate.iterator()

composePaginateRest and composePaginateRest.iterator

How it works

Types

PaginateInterface

PaginatingEndpoints

isPaginatingEndpoint

Contributing

License

10

10

10

10

10

10

10

9

9

4

0

0

0

7.5

/10

`octokit.paginate()`

`octokit.paginate.iterator()`

`composePaginateRest` and `composePaginateRest.iterator`