Package Exports
- @octokit/request-error
- @octokit/request-error/dist-node/index.js
- @octokit/request-error/dist-src/index.js
- @octokit/request-error/dist-web/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@octokit/request-error) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
http-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 const { RequestError } = require("@octokit/request-error");
// or: import { RequestError } from "@octokit/request-error"; |
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;
}
}