Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose RequestError #1688

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

georeith
Copy link

@georeith georeith commented Mar 12, 2024

This PR exposes RequestError which is the error class used by any of the octokit request functions:

try {
   await octokit.rest.git.getRef({
      owner,
      repo,
      ref,
    });
  } catch (err: unknown) {
    if (err instanceof RequestError && err.status === 404) {
      // ...
    }
  }

It is important that this is exposed by this library because it originates from the @octokit/request-error package, however if the user installs the wrong version of @octokit/request-error that does not match the one imported by this library via @octokit/core then you are unable to use instanceof checks to narrow this error.

As an end user of this library it is not easy to keep these versions in lockstep as you do not import @octokit/core directly and this library does not version in lockstep with @octokit/core so it is greatly simplified and less error prone if this library just exports the specific class it already uses.

image

@georeith georeith requested a review from a team as a code owner March 12, 2024 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant