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

📝 Export Token, document token types #400

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

Conversation

NatoBoram
Copy link

@NatoBoram NatoBoram commented Mar 28, 2024


2 changes were made:

  • Exported everything from all files Token
  • Reserved index.ts for exporting the package's content

Before the change?

// Module '"@octokit/auth-token"' declares 'Token' locally, but it is not exported. ts(2459)
import type { Token } from "@octokit/auth-token"

After the change?

// It works!
import type { Token } from "@octokit/auth-token"

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

Copy link

👋 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! 🚀

@gr2m
Copy link
Contributor

gr2m commented Mar 28, 2024

Token is really just a string 🤷🏼

I don't think exporting everything is a good idea, we only want to export the authentication strategy like we do with other @octokit/auth-* or octokit-auth-* packages. But you can always export types that would be useful to consumers.

src/types.ts Outdated Show resolved Hide resolved
@NatoBoram NatoBoram changed the title 🏷️ Export everything 📝 Export Token, document token types Mar 29, 2024
@wolfy1339
Copy link
Member

Can you split the changes into separate PRs.
I'd like to get that merged and then properly review the other changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

[BUG]: Module @octokit/auth-token declares Token locally, but it is not exported.
3 participants