Skip to content
This repository has been archived by the owner on Dec 2, 2024. It is now read-only.

Add UPGRADING.md #143

Merged
merged 8 commits into from
Jun 17, 2018
Merged

Add UPGRADING.md #143

merged 8 commits into from
Jun 17, 2018

Conversation

vweevers
Copy link
Member

Closes #70.

Many things mentioned here can be moved to the readme later (#123).

@vweevers vweevers requested a review from ralphtheninja June 15, 2018 13:33
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`.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to => too

Copy link
Member

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?

Copy link
Member Author

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.

@vweevers
Copy link
Member Author

@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).

@vweevers vweevers removed the request for review from ralphtheninja June 16, 2018 11:25
@vweevers vweevers changed the title Add UPGRADING.md Add UPGRADING.md [WIP] Jun 16, 2018
@vweevers vweevers self-assigned this Jun 16, 2018
@vweevers vweevers requested a review from ralphtheninja June 16, 2018 15:53
@vweevers vweevers changed the title Add UPGRADING.md [WIP] Add UPGRADING.md Jun 16, 2018
Copy link
Member

@ralphtheninja ralphtheninja left a 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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fulfilling

@vweevers vweevers dismissed ralphtheninja’s stale review June 17, 2018 08:41

Trying out the "Dismiss review" feature

@vweevers vweevers merged commit 97c464f into master Jun 17, 2018
@vweevers vweevers deleted the upgrading branch June 17, 2018 09:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants