[FEAT]: Allow streaming of the data

[Uzlopak]

Describe the need

Currently octokit/request is not configurable to provide the stream of the response.body. This is an issue, if you want to load the tarball of a project and want to stream it to a tar stream and process the file content on the fly.

There should be an option, which results in passing the body as stream, so that we can utilitze it if needed.

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[gr2m]

For this use case, we recommend you use @octokit/endpoint with your own request method. You can access it at request.endpoint()

Like this

// https://docs.github.com/en/rest/repos/contents?apiVersion=2022-11-28#download-a-repository-archive-tar
const requestOptions = request.endpoint('GET /repos/{owner}/{repo}/tarball/{ref}', {
  owner: 'OWNER',
  repo: 'REPO',
  ref: 'REF'
})

// {
//   method: 'GET',
//   url: 'https://api.github.com/repos/OWNER/REPO/tarball/REF',
//   headers: {
//     accept: 'application/vnd.github.v3+json',
//     'user-agent': 'octokit-core.js/0.0.0-development Node.js/16.20.1 (darwin; arm64)'
//   },
// }

Note that you will have to set the authorization header yourself if you use an octokit instance. The resulting object of calling octokit.request.endpoint(...) will not set it. The authorization header is only set before sending an actual request

[Uzlopak]

Tbh, this doesnt help me. I just used in our bot built in fetch, because there is no benefit in using a package, if I have to set everything manually. The only benefit of using octokit is the potential typesafety. If i have no typesafety then i dont need the package.

[Uzlopak]

As i see that you added the "support" tags. If you need support to implement this feature, then could have a look, in providing a PR.

[gr2m]

if I have to set everything manually. The only benefit of using octokit is the potential typesafety. If i have no typesafety then i dont need the package

that's okay, we can't make it work for all possible use cases, everything is a trade off. If this is the only request you need to send, I'd use native fetch, too.

[Uzlopak]

Sry but this is not what I expected. I did not expected that my issue gets demoted from feature request to a support request. I expected some feedback regarding the possibility to land this feature and maybe the invitation to provide a PR.

[gr2m]

okay if you like to give it a go, you can certainly send a pull request and we can discuss it there.

Beware that we are currently discussing an introduction of options.request.fetchOptions which could be useful in this context.

How do you stream the response with a native fetch currently? Does it work across Node / Browsers / Deno?