diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f4edec..7e8a298 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,25 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ +## [7.0.0] - 2021-04-17 + +### Changed + +- **Breaking:** bump `leveldown` and `level-packager` ([`53bd922`](https://github.com/Level/level/commit/53bd922)) (Vincent Weevers) +- **Breaking:** bump `level-js` from 5.x to 6.x ([#194](https://github.com/Level/level/issues/194)) ([`1f6c603`](https://github.com/Level/level/commit/1f6c603)) (Alex Potsides) +- **Breaking:** modernize syntax ([Level/community#98](https://github.com/Level/community/issues/98)) ([`d001b2c`](https://github.com/Level/level/commit/d001b2c)) (Vincent Weevers) +- Add `files` to `package.json` and remove `.npmignore` ([`329e1f5`](https://github.com/Level/level/commit/329e1f5)) (Vincent Weevers) + +### Added + +- Document chained batch encoding options ([Level/levelup#633](https://github.com/Level/levelup/issues/633)) ([`0b3c11d`](https://github.com/Level/level/commit/0b3c11d)) (Vincent Weevers) +- Document the `clear` event ([Level/community#79](https://github.com/Level/community/issues/79)) ([`52314bf`](https://github.com/Level/level/commit/52314bf)) (Vincent Weevers) + +### Removed + +- **Breaking:** drop node 8 ([Level/community#98](https://github.com/Level/community/issues/98)) ([`f8a0047`](https://github.com/Level/level/commit/f8a0047), [`31317a6`](https://github.com/Level/level/commit/31317a6)) (Vincent Weevers) +- Remove legacy range options from README ([Level/community#86](https://github.com/Level/community/issues/86)) ([`e56c6b1`](https://github.com/Level/level/commit/e56c6b1)) (Vincent Weevers) + ## [6.0.1] - 2020-03-04 ### Changed @@ -371,6 +390,8 @@ _**If you are upgrading:** please see [`UPGRADING.md`](UPGRADING.md)._ :seedling: Initial release. +[7.0.0]: https://github.com/Level/level/compare/v6.0.1...v7.0.0 + [6.0.1]: https://github.com/Level/level/compare/v6.0.0...v6.0.1 [6.0.0]: https://github.com/Level/level/compare/v5.0.1...v6.0.0 diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 8e30cc2..8f50984 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,14 +1,16 @@ # Contributors -| Name | GitHub | Social | -| :------------------------- | :--------------------------------------------------------------- | :------------------------------------------------------------ | -| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) | -| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) | -| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) | -| **jess** | [**@monkeywithacupcake**](https://github.com/monkeywithacupcake) | | -| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) | -| **Tim Oxley** | [**@timoxley**](https://github.com/timoxley) | [**@secoif@twitter**](https://twitter.com/secoif) | -| **Andrew Kelley** | [**@andrewrk**](https://github.com/andrewrk) | | -| **Joseph Dykstra** | [**@ArtskydJ**](https://github.com/ArtskydJ) | | -| **Matt Walters** | [**@mateodelnorte**](https://github.com/mateodelnorte) | | -| **RasmusErik Voel Jensen** | [**@rasmuserik**](https://github.com/rasmuserik) | | +| Name | GitHub | Social | +| :--------------------------- | :--------------------------------------------------------------- | :------------------------------------------------------------ | +| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) | +| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) | +| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) | +| **jess** | [**@monkeywithacupcake**](https://github.com/monkeywithacupcake) | | +| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) | +| **Tim Oxley** | [**@timoxley**](https://github.com/timoxley) | [**@secoif@twitter**](https://twitter.com/secoif) | +| **Alex Potsides** | | | +| **Andrew Kelley** | [**@andrewrk**](https://github.com/andrewrk) | | +| **Andrii Shumada** | | | +| **Joseph Dykstra** | [**@ArtskydJ**](https://github.com/ArtskydJ) | | +| **Matt Walters** | [**@mateodelnorte**](https://github.com/mateodelnorte) | | +| **RasmusErik Voel Jensen** | [**@rasmuserik**](https://github.com/rasmuserik) | | diff --git a/README.md b/README.md index 2bb16b9..fceabbc 100644 --- a/README.md +++ b/README.md @@ -21,10 +21,28 @@ - [Usage](#usage) - [Supported Platforms](#supported-platforms) - [API](#api) + - [`db = level(location[, options[, callback]])`](#db--levellocation-options-callback) + - [`db.supports`](#dbsupports) + - [`db.open([callback])`](#dbopencallback) + - [`db.close([callback])`](#dbclosecallback) + - [`db.put(key, value[, options][, callback])`](#dbputkey-value-options-callback) + - [`db.get(key[, options][, callback])`](#dbgetkey-options-callback) + - [`db.del(key[, options][, callback])`](#dbdelkey-options-callback) + - [`db.batch(array[, options][, callback])` _(array form)_](#dbbatcharray-options-callback-array-form) + - [`db.batch()` _(chained form)_](#dbbatch-chained-form) + - [`db.isOpen()`](#dbisopen) + - [`db.isClosed()`](#dbisclosed) + - [`db.createReadStream([options])`](#dbcreatereadstreamoptions) + - [`db.createKeyStream([options])`](#dbcreatekeystreamoptions) + - [`db.createValueStream([options])`](#dbcreatevaluestreamoptions) + - [`db.iterator([options])`](#dbiteratoroptions) + - [`db.clear([options][, callback])`](#dbclearoptions-callback) - [Promise Support](#promise-support) - [Events](#events) - [Contributing](#contributing) - [Donate](#donate) + - [Backers](#backers) + - [Sponsors](#sponsors) - [License](#license) diff --git a/UPGRADING.md b/UPGRADING.md index 01488b1..2ae8196 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -2,6 +2,31 @@ This document describes breaking changes and how to upgrade. For a complete list of changes including minor and patch releases, please refer to the [changelog](CHANGELOG.md). +## 7.0.0 + +Legacy range options have been removed ([Level/community#86](https://github.com/Level/community/issues/86)). If you previously did: + +```js +db.createReadStream({ start: 'a', end: 'z' }) +``` + +An error would now be thrown and you must instead do: + +```js +db.createReadStream({ gte: 'a', lte: 'z' }) +``` + +The same applies to `db.iterator()`, `db.createKeyStream()` and `db.createValueStream()`. + +This release also drops support of legacy runtime environments ([Level/community#98](https://github.com/Level/community/issues/98)): + +- Node.js 6 and 8 +- Internet Explorer 11 +- Safari 9-11 +- Stock Android browser (AOSP). + +Lastly, in browsers, the [`immediate`](https://github.com/calvinmetcalf/immediate) and `process` browser shims for `process.nextTick()` have been replaced with the smaller [`queue-microtask`](https://github.com/feross/queue-microtask), except in streams. In the future we might use `queueMicrotask()` in Node.js too. + ## 6.0.0 **No breaking changes to the `level` API. If you're only using `level` in Node.js or Electron, you can upgrade without thinking twice.** diff --git a/package.json b/package.json index a19881f..7edad2d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "level", - "version": "6.0.1", + "version": "7.0.0", "description": "Fast & simple storage - a Node.js-style LevelDB wrapper (a convenience package bundling LevelUP & LevelDOWN)", "license": "MIT", "main": "level.js",