Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prepare 6.0.1 #76

Merged
merged 3 commits into from
Dec 27, 2018
Merged

Prepare 6.0.1 #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7c2f91c
replace remark-cli with hallmark
vweevers Dec 27, 2018
ba244fd
changelog: 6.0.1
vweevers Dec 27, 2018
b363c8b
npm run hallmark
vweevers Dec 27, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 79 additions & 63 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,275 +2,291 @@

## [Unreleased]

## [6.0.1] - 2018-12-27

### Changed

- Replace `remark-cli` devDependency with `hallmark` ([#76](https://github.com/level/encoding-down/issues/76)) ([**@vweevers**](https://github.com/vweevers))

### Added

- Increase coverage to 100% ([#75](https://github.com/level/encoding-down/issues/75)) ([**@vweevers**](https://github.com/vweevers))

### Fixed

- Fix `approximateSize()` to encode `start` and `end` arguments ([#75](https://github.com/level/encoding-down/issues/75)) ([**@vweevers**](https://github.com/vweevers))

## [6.0.0] - 2018-12-25

### Changed

- Prefer `const` over `var` in README ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Upgrade `abstract-leveldown` dependency from `^5.0.0` to `^v6.0.0` ([#68](https://github.com/level/encoding-down/issues/68)) ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Upgrade `standard` devDependency from `^11.0.0` to `^v12.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Use full link references in README ([#60](https://github.com/level/encoding-down/issues/60)) ([**@vweevers**](https://github.com/vweevers))
- Prefer `const` over `var` in README ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Upgrade `abstract-leveldown` dependency from `^5.0.0` to `^v6.0.0` ([#68](https://github.com/level/encoding-down/issues/68)) ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Upgrade `standard` devDependency from `^11.0.0` to `^v12.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Use full link references in README ([#60](https://github.com/level/encoding-down/issues/60)) ([**@vweevers**](https://github.com/vweevers))

### Added

- Explain serialization ([#72](https://github.com/level/encoding-down/issues/72)) ([**@vweevers**](https://github.com/vweevers))
- Add `nyc` and `coveralls` ([#64](https://github.com/level/encoding-down/issues/64)) ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Explain serialization ([#72](https://github.com/level/encoding-down/issues/72)) ([**@vweevers**](https://github.com/vweevers))
- Add `nyc` and `coveralls` ([#64](https://github.com/level/encoding-down/issues/64)) ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Removed

- Remove node 9 ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Remove now superfluous `_setupIteratorOptions()` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Remove node 9 ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Remove now superfluous `_setupIteratorOptions()` ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [5.0.4] - 2018-06-22

### Added

- Add `LICENSE.md` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add `CONTRIBUTORS.md` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add `remark` tooling ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add `LICENSE.md` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add `CONTRIBUTORS.md` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add `remark` tooling ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [5.0.3] - 2018-05-30

### Changed

- Replace `util.inherits` with `inherits` module ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Replace `util.inherits` with `inherits` module ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [5.0.2] - 2018-05-23

### Added

- Add `UPGRADING.md` ([**@vweevers**](https://github.com/vweevers))
- Add `UPGRADING.md` ([**@vweevers**](https://github.com/vweevers))

### Changed

- Upgrade `abstract-leveldown` to `5.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Upgrade `memdown` to `3.0.0` ([**@vweevers**](https://github.com/vweevers))
- Upgrade `abstract-leveldown` to `5.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Upgrade `memdown` to `3.0.0` ([**@vweevers**](https://github.com/vweevers))

## [5.0.1] - 2018-05-19

### Changed

- Override `_setupIteratorOptions` to not clobber ranges ([**@ralphtheninja**](https://github.com/ralphtheninja), [**@dominictarr**](https://github.com/dominictarr))
- Override `_setupIteratorOptions` to not clobber ranges ([**@ralphtheninja**](https://github.com/ralphtheninja), [**@dominictarr**](https://github.com/dominictarr))

## [4.0.1] - 2018-05-19

### Changed

- Override `_setupIteratorOptions` to not clobber ranges ([**@ralphtheninja**](https://github.com/ralphtheninja), [**@dominictarr**](https://github.com/dominictarr))
- Override `_setupIteratorOptions` to not clobber ranges ([**@ralphtheninja**](https://github.com/ralphtheninja), [**@dominictarr**](https://github.com/dominictarr))

## [5.0.0] - 2018-05-13

### Added

- Add 10 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add 10 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Changed

- Update `level-errors` to `2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `level-codec` to `9.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `level-errors` to `2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `level-codec` to `9.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Removed

- Remove 4 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Remove 4 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [4.0.0] - 2018-02-12

### Added

- Add 9 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add 9 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Changed

- Update `abstract-leveldown` to `4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `memdown` to `2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `abstract-leveldown` to `4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `memdown` to `2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Removed

- Remove 7 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Remove 7 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [3.0.1] - 2017-12-18

### Added

- Test that default utf8 encoding stringifies numbers ([**@vweevers**](https://github.com/vweevers))
- Test that default utf8 encoding stringifies numbers ([**@vweevers**](https://github.com/vweevers))

### Fixed

- Skip decoding if `options.keys` or `options.values` is false ([**@vweevers**](https://github.com/vweevers))
- Skip decoding if `options.keys` or `options.values` is false ([**@vweevers**](https://github.com/vweevers))

## [3.0.0] - 2017-11-11

### Added

- README: add node badge (>= 4) ([**@vweevers**](https://github.com/vweevers))
- README: add node badge (>= 4) ([**@vweevers**](https://github.com/vweevers))

### Changed

- Update `abstract-leveldown` to `3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `abstract-leveldown` to `3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Removed

- Remove 0.12 from Travis ([**@vweevers**](https://github.com/vweevers))
- Remove 0.12 from Travis ([**@vweevers**](https://github.com/vweevers))

## [2.3.4] - 2017-10-24

### Added

- README: add example of npm installed encoding ([**@vweevers**](https://github.com/vweevers))
- README: add example of npm installed encoding ([**@vweevers**](https://github.com/vweevers))

## [2.3.3] - 2017-10-22

### Changed

- README: fix `level-codec` links ([**@vweevers**](https://github.com/vweevers))
- README: fix `level-codec` links ([**@vweevers**](https://github.com/vweevers))

## [2.3.2] - 2017-10-22

### Changed

- README: tweak badges ([**@ralphtheninja**](https://github.com/ralphtheninja))
- README: add more code examples ([**@vweevers**](https://github.com/vweevers))
- Update `level-codec` to `8.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- README: tweak badges ([**@ralphtheninja**](https://github.com/ralphtheninja))
- README: add more code examples ([**@vweevers**](https://github.com/vweevers))
- Update `level-codec` to `8.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Fixed

- Fix problems related to missing `asBuffer`, `keyAsBuffer` and `valueAsBuffer` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Fix problems related to missing `asBuffer`, `keyAsBuffer` and `valueAsBuffer` ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [2.3.1] - 2017-10-02

### Changed

- Refactor typings ([**@MeirionHughes**](https://github.com/MeirionHughes))
- Refactor typings ([**@MeirionHughes**](https://github.com/MeirionHughes))

## [2.3.0] - 2017-09-24

### Added

- Add default export ([**@zixia**](https://github.com/zixia))
- Add default export ([**@zixia**](https://github.com/zixia))

## [2.2.1] - 2017-09-13

### Fixed

- Fix typings ([**@MeirionHughes**](https://github.com/MeirionHughes))
- Fix typings ([**@MeirionHughes**](https://github.com/MeirionHughes))

## [2.2.0] - 2017-09-12

### Added

- Add Typescript typings ([**@MeirionHughes**](https://github.com/MeirionHughes))
- Add Typescript typings ([**@MeirionHughes**](https://github.com/MeirionHughes))

### Changed

- README: `AbstractLevelDOWN` -> `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- README: `AbstractLevelDOWN` -> `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [2.1.5] - 2017-08-18

### Added

- README: add api docs ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add basic tests ([**@ralphtheninja**](https://github.com/ralphtheninja))
- README: add api docs ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Add basic tests ([**@ralphtheninja**](https://github.com/ralphtheninja))

### Changed

- Enable Travis for ci ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update dependencies ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Use `safe-buffer` ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Enable Travis for ci ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Update dependencies ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Use `safe-buffer` ([**@ralphtheninja**](https://github.com/ralphtheninja))

## [2.1.4] - 2017-01-26

### Fixed

- Rename methods to `_serializeKey()` and `_serializeValue()` ([**@juliangruber**](https://github.com/juliangruber))
- Rename methods to `_serializeKey()` and `_serializeValue()` ([**@juliangruber**](https://github.com/juliangruber))

## [2.1.3] - 2017-01-26

### Added

- Add `_encodeKey()` and `_encodeValue()` id functions ([**@juliangruber**](https://github.com/juliangruber))
- Add `_encodeKey()` and `_encodeValue()` id functions ([**@juliangruber**](https://github.com/juliangruber))

## [2.1.2] - 2017-01-26

### Fixed

- Emit encoding errors in streams too ([**@juliangruber**](https://github.com/juliangruber))
- Emit encoding errors in streams too ([**@juliangruber**](https://github.com/juliangruber))

## [2.1.1] - 2017-01-26

### Fixed

- Return encoding errors on get ([**@juliangruber**](https://github.com/juliangruber))
- Return encoding errors on get ([**@juliangruber**](https://github.com/juliangruber))

## [2.1.0] - 2017-01-26

### Added

- Add support for `approximateSize()` ([**@juliangruber**](https://github.com/juliangruber))
- Add support for `approximateSize()` ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.8] - 2017-01-26

### Removed

- Remove `Iterator.prototype.seek` ([**@juliangruber**](https://github.com/juliangruber))
- Remove `Iterator.prototype.seek` ([**@juliangruber**](https://github.com/juliangruber))

### Fixed

- Fix encoding lt/get range options ([**@juliangruber**](https://github.com/juliangruber))
- Fix encoding lt/get range options ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.7] - 2017-01-26

### Added

- Add `'utf8'` as default encoding ([**@juliangruber**](https://github.com/juliangruber))
- Add `'utf8'` as default encoding ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.6] - 2017-01-26

### Fixed

- Fix `typof` -> `typeof` bug ([**@juliangruber**](https://github.com/juliangruber))
- Fix `typof` -> `typeof` bug ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.5] - 2017-01-26

### Fixed

- Fix bug in `iterator._next()` with undefined key or value ([**@juliangruber**](https://github.com/juliangruber))
- Fix bug in `iterator._next()` with undefined key or value ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.4] - 2017-01-26

### Changed

- Update `level-codec` for utf8 fixes ([**@juliangruber**](https://github.com/juliangruber))
- Update `level-codec` for utf8 fixes ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.3] - 2017-01-26

### Fixed

- Fix bug with incorrect db ([**@juliangruber**](https://github.com/juliangruber))
- Fix bug with incorrect db ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.2] - 2017-01-26

### Fixed

- Fix bug with incorrect db and missing new operator ([**@juliangruber**](https://github.com/juliangruber))
- Fix bug with incorrect db and missing new operator ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.1] - 2017-01-26

### Fixed

- Fix bug with `AbstractChainedBatch` inheritance ([**@juliangruber**](https://github.com/juliangruber))
- Fix bug with `AbstractChainedBatch` inheritance ([**@juliangruber**](https://github.com/juliangruber))

## [2.0.0] - 2017-01-26

### Changed

- Version bump ([**@juliangruber**](https://github.com/juliangruber))
- Version bump ([**@juliangruber**](https://github.com/juliangruber))

## 1.0.0 - 2017-01-26

:seedling: Initial release.

[unreleased]: https://github.com/level/encoding-down/compare/v6.0.0...HEAD
[unreleased]: https://github.com/level/encoding-down/compare/v6.0.1...HEAD

[6.0.1]: https://github.com/level/encoding-down/compare/v6.0.0...v6.0.1

[6.0.0]: https://github.com/level/encoding-down/compare/v5.0.4...v6.0.0

Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ db.put('example', 42, function (err) {

### `db = require('encoding-down')(db[, options])`

- `db` must be an [`abstract-leveldown`][abstract-leveldown] compliant store
- `options` are passed to [`level-codec`][level-codec]:
- `keyEncoding`: encoding to use for keys
- `valueEncoding`: encoding to use for values
- `db` must be an [`abstract-leveldown`][abstract-leveldown] compliant store
- `options` are passed to [`level-codec`][level-codec]:
- `keyEncoding`: encoding to use for keys
- `valueEncoding`: encoding to use for values

Both encodings default to `'utf8'`. They can be a string (builtin `level-codec` encoding) or an object (custom encoding).

Expand Down
Loading