search

Level / level-js

An abstract-leveldown compliant store on top of IndexedDB.
MIT License
544 stars 44 forks source link

Add API documentation #103

Closed vweevers closed 6 years ago

ralphtheninja commented 6 years ago

TODO

vweevers commented 6 years ago

Should those be public though? I didn't think about that part

ralphtheninja commented 6 years ago

Actually, unassigning myself. Better if @vweevers does this.

ralphtheninja commented 6 years ago

Should those be public though? I didn't think about that part

They could be just var binaryKeys = .. etc instead.

ralphtheninja commented 6 years ago

I think in general it's probably easiest to take the same structure from leveldown and take one method at a time instead of copying over docs from leveldown and tweaking it.

vweevers commented 6 years ago

I'm not sure we even need API docs beyond the constructor (where it differs from abstract-leveldown).

ralphtheninja commented 6 years ago

I'm not sure we even need API docs beyond the constructor (where it differs from abstract-leveldown).

I should be able to fix that at least :wink: