Uploading binary data

[ssured]

Thanks for the library!

When writing binary data to GitHub the API seems a little weird. Consider buffer to contain a gif image.

This code does not work:

branch.write({
  "image.gif": {
    isBase64: true,
    content: buffer.toString('base64')
  }
});

This code works:

branch.write({
  "image.gif": {
    isBase64: true,
    content: buffer.toString('binary')
  }
});

It feels really weird to provide a binary string and specifying isBase64

https://github.com/philschatz/octokit.js/blob/master/octokit.js#L764-L766 causes the problem. Some simple API aligning will fix the issue.

[philschatz]

Thanks for the issue. Are you using this library in NodeJS or in the browser?

Is renaming isBase64 to isBinary sufficient?

[ssured]

I am using NodeJS right now.

Yes, renaming to isBinary is sufficient.

Even nicer would be to check for a Buffer (content instanceof Buffer) object, if so, consider it binary data and call content.toString(‘base64’). Browsers < IE10 need a little care in that case http://caniuse.com/typedarrays

[Kedrigern]

Hi, I have similar problem. Is relevant? Is this solved?

Details and minimal working example.