bl icon indicating copy to clipboard operation
bl copied to clipboard

Your docs could be friendlier to web devs

Open mcclure opened this issue 4 years ago • 1 comments

Hi, I found myself using your BufferList today. I was initially very confused because the docs mostly assume node.js and I am developing for browser. I needed a Uint8Array but I could not figure out how to get one. A friend explained that it is very simple to get a uint8array out of a node buffer but I did not know that coming in.

Because your library does work in browser, maybe it would be a good idea to add a sentence or two explaining how to convert to and from a Buffer from a uint8array/ArrayBuffer, or something like "to get typed array types like Uint8Array, read here" with a link to the relevant section from the Node documentation. Thanks.

mcclure avatar Jul 19 '21 20:07 mcclure

Thanks! Would you like to send a PR?

mcollina avatar Jul 19 '21 21:07 mcollina