npmpackage.info

Gathering detailed insights and metrics for @octokit/request-error

Other packages similar to @octokit/request-error

@octokit/plugin-request-log

5.3.1

Log all requests and request errors

@octokit/request

9.1.3

Send parameterized requests to GitHub's APIs with sensible defaults in browsers and Node

@octokit/endpoint

10.1.1

Turns REST API endpoints into generic request options

@octokit/core

6.1.2

Extendable client for GitHub's REST & GraphQL APIs

Gathering detailed insights and metrics for @octokit/request-error

@octokit/request-error

Error class for Octokit request errors

6.1.5

MIT

TypeScript

1,603,428,307 7.7

Installations

npm install @octokit/request-error

Score

98.4

Supply Chain

Quality

87.6

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

455

Closed

13

Merged

441

Issues

Open

0

Total

21

Closed

21

Releases

v6.1.5

Published on 24 Sept 2024

v6.1.4

Published on 11 Jul 2024

v6.1.3

Published on 11 Jul 2024

v6.1.2

Published on 10 Jul 2024

v6.1.1

Published on 16 Apr 2024

v5.1.0

Published on 05 Apr 2024

View all 41 releases

Developer

octokit

Developer Guide

BETA

Module System

ESM

Min. Node Version

>= 18

Typescript Support

Yes

Node Version

20.17.0

NPM Version

10.8.3 Statistics

14 Stars

528 Commits

11 Forks

9 Watching

7 Branches

17 Contributors

Updated on 26 Nov 2024

Languages

TypeScript (61.9%)

JavaScript (38.1%)

Total Downloads

Cumulative downloads

Total Downloads

1,603,428,307

Last day

1.6%

2,395,675

Compared to previous day

Last week

6.5%

12,980,767

Compared to previous week

Last month

10.7%

51,893,039

Compared to previous month

Last year

20.7%

494,602,892

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@octokit/types

Dev Dependencies

@octokit/tsconfig @types/node @vitest/coverage-v8 esbuild glob prettier tinybench typescript vitest

Versions

request-error.js

Error class for Octokit request errors

Usage

Browsers

Browsers	Load `@octokit/request-error` directly from esm.sh `1<script type="module"> 2import { RequestError } from "https://esm.sh/@octokit/request-error"; 3</script>`
Node	Install with `npm install @octokit/request-error` `1import { RequestError } from "@octokit/request-error";`

Load @octokit/request-error directly from esm.sh

1<script type="module">
2import { RequestError } from "https://esm.sh/@octokit/request-error";
3</script>

Node

Install with npm install @octokit/request-error

1import { RequestError } from "@octokit/request-error";

[!IMPORTANT] As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16".

See the TypeScript docs on package.json "exports".
See this helpful guide on transitioning to ESM from @sindresorhus

1const error = new RequestError("Oops", 500, {
2  request: {
3    method: "POST",
4    url: "https://api.github.com/foo",
5    body: {
6      bar: "baz",
7    },
8    headers: {
9      authorization: "token secret123",
10    },
11  },
12  response: {
13    status: 500,
14    url: "https://api.github.com/foo",
15    headers: {
16      "x-github-request-id": "1:2:3:4",
17    },
18    data: {
19      foo: "bar",
20    },
21  },
22});
23
24error.message; // Oops
25error.status; // 500
26error.request; // { method, url, headers, body }
27error.response; // { url, status, headers, data }

Usage with Octokit

1try {
2  // your code here that sends at least one Octokit request
3  await octokit.request("GET /");
4} catch (error) {
5  // Octokit errors always have a `error.status` property which is the http response code
6  if (error.status) {
7    // handle Octokit error
8  } else {
9    // handle all other errors
10    throw error;
11  }
12}

LICENSE

MIT

No vulnerabilities found.

10

Dangerous-Workflow

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

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

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

10

Code-Review

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

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

Security-Policy

Determines if the project has published a security policy.

5

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 5

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/request-error.js/add_to_octokit_project.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/request-error.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/request-error.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/request-error.js/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/request-error.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/request-error.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/request-error.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/request-error.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/request-error.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/request-error.js/test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/request-error.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/request-error.js/update-prettier.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/request-error.js/update-prettier.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-prettier.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/octokit/request-error.js/update-prettier.yml/main?enable=pin
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned
Info: 4 out of 4 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.7

/10

Last Scanned on 2024-11-18

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