-
-
Notifications
You must be signed in to change notification settings - Fork 44
Add UPGRADING.md #143
Add UPGRADING.md #143
Conversation
UPGRADING.md
Outdated
|
||
Due to the special meaning that `null` and `undefined` have in `abstract-leveldown` iterators and Node.js streams, values of this type are converted to empty strings prior to storage. | ||
|
||
:point_up: The structured clone algorithm can be slower than `JSON.stringify`, so don't to quick to eschew `encoding-down`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to => too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When wrapping with level-browserify, maybe we should provide an option to use encoding-down or not?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO levelup(leveljs())
is just fine, or even better for composition than options.
@ralphtheninja if you want I can move some stuff to the readme as part of this PR, closing #123. Then you can review everything in one go and we can release 3.0.0 (skipping rc2). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tiny typo. Otherwise LVGTM!
UPGRADING.md
Outdated
|
||
In `level-js`, iterators are powered by IndexedDB cursors. To fulfill [`abstract-leveldown`][abstract-leveldown] snapshot guarantees (reads not being affected by simultaneous writes) cursors are started immediately and continuously read from, filling an in-memory cache. | ||
|
||
Though `level-js` now passes the full [`abstract-leveldown`][abstract-leveldown] test suite, fulfulling the snapshot guarantee means a loss of backpressure. Memory consumption might increase if an iterator is not consumed fast enough. A future release will have an option to favor backpressure over snapshot guarantees. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fulfilling
Trying out the "Dismiss review" feature
Closes #70.
Many things mentioned here can be moved to the readme later (#123).