feat: add parseSuccessResponseBody Option

[Uzlopak]

This is currently more a poc than the final implementation.

Resolves #601

---

Behavior

Before the change?

After the change?

Other information

---

Additional info

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)
• Added the appropriate label for the given change

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

• Yes (Please add the Type: Breaking change label)
• No

If Yes, what's the impact:

• N/A

Pull request type

Please add the corresponding label for change this PR introduces:

• Bugfix: Type: Bug
• Feature/model/API additions: Type: Feature
• Updates to docs or samples: Type: Documentation
• Dependencies/code cleanup: Type: Maintenance

---

[wolfy1339]

The type updates for the function need to made in @octokit/types

That can be handled later when this is greenlit

[Uzlopak]

Ok i modified it. Now test coverage is not 100% but i would add corresponding unit tests, if you say, this is the way to go.

[Uzlopak]

Tbh i am not that happy about the name parseResponse. Maybe call it parseResponseBody or parseResponseData?

[gr2m]

Tbh i am not that happy about the name parseResponse. Maybe call it parseResponseBody or parseResponseData?

Agree, that's better. We could even make it more explicit and call it parseSuccessResponseBody to make clear that the option only applies to success responses, to address our discussion above.

[Uzlopak]

blub

[Uzlopak]

In the whole code base it is response.data.

[wolfy1339]

In the whole code base it is response.data.

That is handled by @octokit/endpoint, it's a different parameter than body.

https://github.com/octokit/request.js/pull/599/files#r1256484656

[gr2m]

Looks good to me now!

@Uzlopak Can you confirm the change works for your usecase? To test you can run npm run build and then import { request } from the pkg/ folder

[wolfy1339]

I pushed the update to @octokit/types, simply need to remove the manual definition here and upgrade @octokit/types

[Uzlopak]

@wolfy1339
done

[github-actions]

🎉 This PR is included in version 8.1.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀

[gr2m]

@Uzlopak thank you for seeing this through. I'm sorry I closed #601 prematurely, that was wrong the wrong call. I'm glad you didn't give up on it, the resulting pull request turned out really great and it unlocked a use case I thought we couldn't really cover without adding a lot of complexity to the core functionality of Octokit. Thank you 💐

[Uzlopak]

@gr2m

Thank you for your kind words. :)