gh-action-bump-version/node_modules/@octokit/request-error/README.md

1.6 KiB

http-error.js

Error class for Octokit request errors

@latest Build Status Greenkeeper

Usage

Browsers Load @octokit/request-error directly from cdn.pika.dev
<script type="module">
import { RequestError } from "https://cdn.pika.dev/@octokit/request-error";
</script>
Node

Install with npm install @octokit/request-error

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

error.message; // Oops
error.status; // 500
error.headers; // { 'x-github-request-id': '1:2:3:4' }
error.request.method; // POST
error.request.url; // https://api.github.com/foo
error.request.body; // { bar: 'baz' }
error.request.headers; // { authorization: 'token [REDACTED]' }

LICENSE

MIT