Documentation

[daviddias]

We don't have all the funcs available through this lib documented.

We also don't have documented the optional dependency, which causes confusion as seen #70

[dignifiedquire]

ref #48

[daviddias]

Understood, can we have at least a listing of the method names?

Also, #72 this is not part of docs, but should be documented

[daviddias]

Some documentation coming with #102

[paralin]

I'd say it''s still pretty incomplete. I can try to fill it out more down the line

[daviddias]

@paralin thank you! :)

Still looking into it? @richardschneider has pushed a bunch of new calls since then.

[paralin]

Too swamped to handle this right now unfortunately

[carsonfarmer]

Just to update, the types that were recently added to this repo provide pretty much full documentation for all exposed APIs. They could be used to generate code documentation via:

npx typedoc --mode file --includeDeclarations --excludeExternals ./src/index.d.ts