Skip to content

Your docs could be friendlier to web devs #104

@mcclure

Description

@mcclure

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions