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.

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

Your docs could be friendlier to web devs #104

Open
mcclure opened this issue Jul 19, 2021 · 1 comment
Open

Your docs could be friendlier to web devs #104

mcclure opened this issue Jul 19, 2021 · 1 comment

Comments

@mcclure
Copy link

mcclure commented Jul 19, 2021

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.

@mcollina
Copy link
Collaborator

Thanks! Would you like to send a PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants