npmpackage.info

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

@ptomulik/octokit-paginate-rest-limit - 1.1.4 | npmpackage.info

@ptomulik/octokit-paginate-rest-limit

1.1.4

TypeScript

364.00 B

1,373 2.8

Installations

npm install @ptomulik/octokit-paginate-rest-limit

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

12.22.1

NPM Version

7.13.0 Score

70.4

Supply Chain

98.8

Quality

75.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

7

Closed

0

Merged

7

Issues

Open

0

Total

0

Closed

0

Releases

v1.1.4

Updated on May 19, 2021

v1.1.3

Updated on May 16, 2021

v1.1.2

Updated on May 14, 2021

v1.1.1

Updated on May 14, 2021

v1.1.0

Updated on May 14, 2021

v1.0.0

Updated on May 14, 2021

View All 6 releases

Languages

TypeScript

Shell

JavaScript

TypeScript (95.76%)

Shell (2.17%)

JavaScript (2.06%)

Developer

ptomulik

Download Statistics

Total Downloads

1,373

Last Day

Last Week

Last Month

Last Year

197

GitHub Statistics

11 Commits

2 Watchers

2 Branches

1 Contributors

Updated on May 19, 2021

Bundle Size

602.00 B

Minified

364.00 B

Minified + Gzipped

Bundlephobia

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.1.4

Package Id

@ptomulik/octokit-paginate-rest-limit@1.1.4

Unpacked Size

19.22 kB

Size

5.67 kB

File Count

NPM Version

7.13.0

Node Version

12.22.1

Total Downloads

Cumulative downloads

Total Downloads

1,373

Last Day

400%

Compared to previous day

Last Week

-16.7%

Compared to previous week

Last Month

-41.5%

Compared to previous month

Last Year

5.9%

197

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@pika/pack @pika/plugin-build-node @pika/plugin-build-web @pika/plugin-ts-standard-pkg @types/jest @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-jest eslint-plugin-prettier jest prettier semantic-release semantic-release-plugin-update-version-in-files ts-jest tsd typescript

Paginate Rest Limit

Description

Provides callback function that limits number of entries returned by @octokit/plugin-paginate-rest.js.

The paginate method provided by @octokit/plugin-paginate-rest.js fetches all available entries page-by-page and returns them gathered into a single array. The octokit-paginate-rest-limit.ts allows to reduce the number of entries returned (and pages fetched) when only few first records are required.

Usage

Browsers

Browsers	Load `@ptomulik/octokit-paginate-rest-limit` (and related modules) directly from cdn.skypack.dev `1<script type="module"> 2 import { Octokit } from "https://cdn.skypack.dev/@octokit/core"; 3 import { paginateRest } from "https://cdn.skypack.dev/@octokit/plugin-paginate-rest"; 4 import { limit, adjust, MapFunction } from "https://cdn.skypack.dev/@ptomulik/octokit-paginate-rest-limit"; 5</script>`
Node	Install `@ptomulik/octokit-paginate-rest-limit` (and related modules) with `1npm install @ptomulik/octokit-paginate-rest-limit @octokit/plugin-paginate-rest @octokit/core` then import modules in your code `1import { Octokit } from "@octokit/core"; 2import { paginateRest } from "@octokit/plugin-paginate-rest"; 3import { limit, adjust, MapFunction } from "@ptomulik/octokit-paginate-rest-limit";`

Load @ptomulik/octokit-paginate-rest-limit (and related modules) directly from cdn.skypack.dev

1<script type="module">
2  import { Octokit } from "https://cdn.skypack.dev/@octokit/core";
3  import { paginateRest } from "https://cdn.skypack.dev/@octokit/plugin-paginate-rest";
4  import { limit, adjust, MapFunction } from "https://cdn.skypack.dev/@ptomulik/octokit-paginate-rest-limit";
5</script>

Node

Install @ptomulik/octokit-paginate-rest-limit (and related modules) with

1npm install @ptomulik/octokit-paginate-rest-limit @octokit/plugin-paginate-rest @octokit/core

then import modules in your code

1import { Octokit } from "@octokit/core";
2import { paginateRest } from "@octokit/plugin-paginate-rest";
3import { limit, adjust, MapFunction } from "@ptomulik/octokit-paginate-rest-limit";

Applying limit

1import { Octokit } from "@octokit/core";
2import { paginateRest } from "@octokit/plugin-paginate-rest";
3import { limit, MapFunction } from "@ptomulik/octokit-paginate-rest-limit";
4
5const MyOctokit = Octokit.plugin(paginateRest);
6const octokit = new MyOctokit();
7
8type Response = { data: { tag_name: string }[] };
9
10// Retrieve (no more than) 2 releases and print their tag names.
11octokit.paginate(
12  "GET /repos/{owner}/{repo}/releases",
13  {owner: "octokit", repo: "plugin-paginate-rest.js"},
14  limit(2) as MapFunction<Response>
15).then((releases) => {
16  console.log(releases.map((release) => release.tag_name));
17});

Example output

1[ 'v2.13.3', 'v2.13.2' ]

Applying limit & map function at once.

1import { Octokit } from "@octokit/core";
2import { paginateRest } from "@octokit/plugin-paginate-rest";
3import { limit } from "@ptomulik/octokit-paginate-rest-limit";
4
5const MyOctokit = Octokit.plugin(paginateRest);
6const octokit = new MyOctokit();
7
8type Response = { data: { tag_name: string }[] };
9
10// Retrieve (no more than) 2 releases and print their tag names.
11octokit
12  .paginate(
13    "GET /repos/{owner}/{repo}/releases",
14    { owner: "octokit", repo: "plugin-paginate-rest.js" },
15    limit(2, ({ data }: Response) => data.map((release) => release.tag_name))
16  )
17  .then((names) => {
18    console.log(names);
19  });

Adjusting request parameters

Pagination parameters may be adjusted with adjust(max, parameters). This operation adjusts per_page property of parameters to avoid fetching redundant records.

1import { Octokit } from "@octokit/core";
2import { paginateRest } from "@octokit/plugin-paginate-rest";
3import { limit, adjust, MapFunction } from "@ptomulik/octokit-paginate-rest-limit";
4
5const MyOctokit = Octokit.plugin(paginateRest);
6const octokit = new MyOctokit();
7const max = 2;
8
9type Response = { data: { tag_name: string }[] };
10
11// Retrieve (no more than) `max` releases and print their tag names.
12// The `per_page` is set to `max`.
13octokit.paginate(
14  "GET /repos/{owner}/{repo}/releases",
15  adjust(max, {owner: "octokit", repo: "plugin-paginate-rest.js"}),
16  limit(max) as MapFunction<Response>
17).then((releases) => {
18  console.log(releases.map((release) => release.tag_name));
19});

Limitations

incompatible with paginate.iterator,

will cause bugs when a value (function) returned by limit() is reused; namely, this is WRONG:

1  const first = limit(1);
2  octokit.paginate(..., first);
3  octokit.paginate(..., first); // !!this will not work as one would expect!!

LICENSE

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

6

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 6

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/build.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/code.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/code.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/code.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/test.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/test.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/ptomulik/octokit-paginate-rest-limit.ts/test.yml/master?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 5 out of 5 npmCommand dependencies pinned

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

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

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

48 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-2h3h-q99f-3fhc
Warn: Project is vulnerable to: GHSA-gmw6-94gg-2rc2
Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-hj9c-8jmm-8c52
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-v4rh-8p82-6h5w
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

2.8

/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