Add UPGRADING.md #143
Merged
Add UPGRADING.md #143
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vweevers
commented
Jun 15, 2018
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.
When wrapping with level-browserify, maybe we should provide an option to use encoding-down or not?
There was a problem hiding this comment.
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). |
ralphtheninja
previously requested changes
Jun 16, 2018
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. |
vweevers
dismissed
ralphtheninja’s stale review
Trying out the "Dismiss review" feature
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #70.
Many things mentioned here can be moved to the readme later (#123).