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.

Sign up for GitHub

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

Jump to bottom

feat: add return types for request.parseSuccessResponseBody #608

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

feat: add return types for request.parseSuccessResponseBody #608

wants to merge 4 commits into from

Conversation

wolfy1339
Copy link
Member

Resolves #606

Before the change?

  • The response types would always return the data as an object whether or not the request.parseSuccessResponseBody was set to false

After the change?

  • The response types take into account the request.parseSuccessResponseBody, and set it to be ReadableStream

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

@wolfy1339 wolfy1339 added the Type: Feature New feature or request label Feb 9, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Feb 9, 2024

👋 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
Copy link
Member Author

This fails the tests, but works in the code when the option is used.

There are some changes that need to be made to have this ready to ship

wolfy1339
wolfy1339 commented Feb 9, 2024
View reviewed changes
test.ts
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tests fail for the assertPaginate test

@wolfy1339 wolfy1339 mentioned this pull request Feb 9, 2024
Closed
1 task
@wolfy1339
Copy link
Member Author

@octokit/js If one of you could have a look and help this along. I would really appreciate the help on this one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
Type: Feature New feature or request
Projects
🧰 Octokit Active
Status: 🏗 In progress
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Response types don't account for parseSuccessResponseBody
1 participant
@wolfy1339