Skip to content

The docs lack a description of all available methods and their expected params and types #286

Open
@distinctdan

Description

@distinctdan

I'm trying to figure out if I can pass an ArrayBuffer to the file writer, but the docs don't have any kind of API documentation, only some scattered examples. I shouldn't have to go and read through the source to find out what each function really accepts. It would be a lot better if the docs included some standard, concise API documentation containing the following:

  • Method name
  • Parameters, whether they're optional, and their accepted types
  • Return value

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions