@octokit/request-error

request-error.js

Error class for Octokit request errors

Usage

Browsers	Load @octokit/request-error directly from esm.sh <script type="module"> import { RequestError } from "https://esm.sh/@octokit/request-error"; </script>
Node	Install with npm install @octokit/request-error import { 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

const error = new RequestError("Oops", 500, {
  request: {
    method: "POST",
    url: "https://api.github.com/foo",
    body: {
      bar: "baz",
    },
    headers: {
      authorization: "token secret123",
    },
  },
  response: {
    status: 500,
    url: "https://api.github.com/foo",
    headers: {
      "x-github-request-id": "1:2:3:4",
    },
    data: {
      foo: "bar",
    },
  },
});

error.message; // Oops
error.status; // 500
error.request; // { method, url, headers, body }
error.response; // { url, status, headers, data }

Usage with Octokit

try {
  // your code here that sends at least one Octokit request
  await octokit.request("GET /");
} catch (error) {
  // Octokit errors always have a `error.status` property which is the http response code
  if (error.status) {
    // handle Octokit error
  } else {
    // handle all other errors
    throw error;
  }
}

LICENSE

MIT

Similar packages

Other packages similar to @octokit/request-error

axios-error

axios-error is a package that provides a similar functionality for Axios, a popular HTTP client. It wraps errors thrown by Axios requests in a more descriptive object, similar to how @octokit/request-error works for Octokit. However, it is specifically tailored for Axios and its error handling patterns.

http-errors

http-errors is a package for creating HTTP error objects. While it does not directly handle errors from HTTP requests like @octokit/request-error, it provides a way to create error objects with status codes and messages, which can be used in a variety of web applications and APIs.