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

[BUG]: OctokitOptions declared locally but not exported #645

Closed
1 task done
mcgear opened this issue Dec 14, 2023 · 7 comments · Fixed by #646
Closed
1 task done

[BUG]: OctokitOptions declared locally but not exported #645

mcgear opened this issue Dec 14, 2023 · 7 comments · Fixed by #646
Labels
released on @5.x released Type: Support Any questions, information, or general needs around the SDK or GitHub APIs

Comments

@mcgear
Copy link
Contributor

mcgear commented Dec 14, 2023

What happened?

I am trying to use OctokitOptions in a typescript project for DenoJS, but am getting the following error when using this import import { OctokitOptions } from "@octokit/core";

image

Not sure how to handle, thanks for the help.

Versions

octokit/core: https://esm.sh/@octokit/core@v5.0.2

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@mcgear mcgear added Status: Triage This is being looked at and prioritized Type: Bug Something isn't working as documented labels Dec 14, 2023
Copy link
Contributor

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

@wolfy1339 wolfy1339 added Type: Support Any questions, information, or general needs around the SDK or GitHub APIs and removed Type: Bug Something isn't working as documented Status: Triage This is being looked at and prioritized labels Dec 14, 2023
@wolfy1339
Copy link
Member

You are getting that error because that export does not exist.

It's imported in the index.ts file but not exported.

If you absolutely need to import it, you can use:

import type from "@octokit/core/dist-types/types.d":

@mcgear
Copy link
Contributor Author

mcgear commented Dec 14, 2023

Its mostly for cleanliness of some helper functions we are establishing for Octokit initialization. Any plans to add this as an export? Would it be an accepted PR?

@wolfy1339
Copy link
Member

You can also do this:

type OctokitOptions = ConstructorParameters<Octokit>;

I'm open to a PR

@mcgear
Copy link
Contributor Author

mcgear commented Dec 18, 2023

Created PR #646

Copy link
Contributor

🎉 This issue has been resolved in version 5.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Copy link
Contributor

github-actions bot commented Apr 3, 2024

🎉 This issue has been resolved in version 5.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released on @5.x released Type: Support Any questions, information, or general needs around the SDK or GitHub APIs
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants