level-packager

levelup package helper for distributing with an abstract-leveldown store.

API

Exports a single function which takes a single argument, an abstract-leveldown compatible storage back-end for levelup. The function returns a constructor function that will bundle levelup with the given abstract-leveldown replacement. The full API is supported, including optional functions, destroy(), and repair(). Encoding functionality is provided by encoding-down.

The constructor function has a .errors property which provides access to the different error types from level-errors.

For example use-cases, see:

• level
• level-mem
• level-hyper
• level-lmdb

Also available is a test.js file that can be used to verify that the user-package works as expected.

If you are upgrading: please see UPGRADING.md.

Contributing

Level/packager is an OPEN Open Source Project. This means that:

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

See the Contribution Guide for more details.

Donate

Support us with a monthly donation on Open Collective and help us continue our work.

License

MIT

Changelog

6.0.1 - 2021-10-02

Fixed

• Bump levelup and encoding-down to prevent dedupe (d3a8fc2) (Vincent Weevers)

6.0.0 - 2021-04-17

If you are upgrading: please see UPGRADING.md.

Changed

• Breaking: modernize syntax and bump standard (Level/community#98) (4770d17) (Vincent Weevers)
• Breaking: bump levelup and encoding-down (c92e054) (Vincent Weevers)
• Add files to package.json (809fb8e) (Vincent Weevers)

Removed

• Breaking: drop node 6 and 8 (Level/community#98) (5fd4a37) (Vincent Weevers)

5.1.1 - 2019-11-29

Fixed

• Pass options to abstract-leveldown store (#96) (@achingbrain). In addition to passing options to the levelup wrapper.

5.1.0 - 2019-10-13

Added

• Support constructing without location (#95) (@vweevers)

Fixed

• Bump levelup and encoding-down to prevent dedupe (cd22e66) (@vweevers)

5.0.3 - 2019-09-08

Changed

• Upgrade hallmark devDependency from ^0.1.0 to ^2.0.0 (#90, #93) (@vweevers)
• Upgrade standard devDependency from ^12.0.0 to ^14.0.0 (#89, #92) (@vweevers)

Fixed

• Bump levelup and encoding-down to prevent dedupe (a293d30) (@vweevers)

5.0.2 - 2019-06-08

Changed

• Upgrade nyc devDependency from ^13.2.0 to ^14.0.0 (#85) (@vweevers)

Added

• Add .npmignore (85b9a84) (@vweevers)

Fixed

• Support variadic arguments in destroy() and repair() (#88) (@vweevers)
• Don't assume existence of a LOG file in abstract destroy-test (#87) (@vweevers)
• Fix Level badge (2429718) (@vweevers)
• Remove link to dead website (d671d63) (@vweevers)

5.0.1 - 2019-03-31

Changed

• Update nyc devDependency from ^12.0.2 to ^13.2.0 (#84) (@vweevers)
• Apply common project tweaks (#82, #83) (@vweevers)

5.0.0 - 2018-12-27

If you are upgrading: please see UPGRADING.md.

Changed

• Upgrade encoding-down from ~5.0.0 to ^6.0.0 (#80, #81) (@vweevers)
• Upgrade levelup from ^3.0.0 to ^4.0.0 (#79) (@ralphtheninja)
• Upgrade standard devDependency from ^11.0.0 to ^12.0.0 (#74) (@ralphtheninja)
• Replace remark-cli devDependency with hallmark (#81) (@vweevers)

Added

• Add nyc and coveralls (#73) (@ralphtheninja)

Removed

• Remove node 9 (29fdaf4) (@ralphtheninja)

4.0.1 - 2018-06-23

Changed

• Use var instead of let (@ralphtheninja)

Added

• Add remark tooling (@ralphtheninja)
• Add 'use strict' to all abstract tests (@ralphtheninja)

Removed

• Remove contributors from package.json (@ralphtheninja)

4.0.0 - 2018-06-13

If you are upgrading: please see UPGRADING.md.

Changed

• Rewrite test.js to test level-packager api (@ralphtheninja)

3.1.0 - 2018-05-28

Changed

• Split up tests into abstract/*-test.js (@ralphtheninja)

Removed

• Remove .jshintrc (@ralphtheninja)

3.0.0 - 2018-05-23

If you are upgrading: please see UPGRADING.md.

Added

• Add node 10 to Travis (@ralphtheninja)
• Add UPGRADING.md (@ralphtheninja)

Changed

• Update standard to ^11.0.0 (@ralphtheninja)
• Update encoding-down to ~5.0.0 (@ralphtheninja)
• Update leveldown to ^4.0.0 (@ralphtheninja)
• Update levelup to ^3.0.0 (@ralphtheninja)
• Change License & Copyright to License in README (@ralphtheninja)
• Replace const with var for IE10 support (@ralphtheninja)

Removed

• Remove node 4 from Travis (@ralphtheninja)

2.1.1 - 2018-02-13

Added

• Travis: add 9 (@ralphtheninja)

Changed

• Update encoding-down to ~4.0.0 (@ralphtheninja)
• Update leveldown to ^3.0.0 (@ralphtheninja)
• Update copyright year to 2018 (@ralphtheninja)

Fixed

• Test: clean up level-test-* dbs after tests are done (@ralphtheninja)

2.1.0 - 2017-12-13

Added

• Add standard for linting (@ralphtheninja)

Changed

• Attach .errors from levelup to Level constructor (@ralphtheninja)

2.0.2 - 2017-11-11

Changed

• Update encoding-down to ~3.0.0 (@vweevers)
• README: update node badge (@vweevers)

Fixed

• Travis: restore node 4 (@vweevers)

2.0.1 - 2017-10-12

Added

• Test that encoding options default to utf8 (@ralphtheninja)
• Test that .keyEncoding and .valueEncoding are passed to encoding-down (@ralphtheninja)

Fixed

• Fix encoding options to encoding-down (@ralphtheninja)

2.0.0 - 2017-10-11

Added

• README: add level badge (@ralphtheninja)

Changed

• Update levelup to ^2.0.0 (@ralphtheninja)
• Update encoding-down to ~2.3.0 (@ralphtheninja)
• Update leveldown to ^2.0.0 (@ralphtheninja)
• README: update npm badges to similar badge style (@ralphtheninja)

Removed

• README: Remove Greenkeeper badge (@ralphtheninja)

2.0.0-rc3 - 2017-09-16

Changed

• Update levelup to 2.0.0-rc3 (@ralphtheninja)
• Update leveldown to ^1.8.0 (@ralphtheninja)

2.0.0-rc2 - 2017-09-12

Changed

• Update levelup to 2.0.0-rc2 (@ralphtheninja)
• Update encoding-down to ~2.2.0 (@ralphtheninja)

2.0.0-rc1 - 2017-09-04

Added

• Travis: add 8 (@ralphtheninja)
• README: add Greenkeeper badge (@ralphtheninja)
• README: add node badge (@ralphtheninja)

Changed

• README: steer away from LevelDOWN to abstract-leveldown (@ralphtheninja)
• Update copyright year to 2017 (@ralphtheninja)

Removed

• Travis: remove 0.12, 4, 5 and 7 (@ralphtheninja)

1.2.1 - 2016-12-27

Added

• Travis: add 6 and 7 (@ralphtheninja)

Changed

• Travis: use gcc 4.8 (@ralphtheninja)

Removed

• Travis: remove 0.10, 1.0, 1.8, 2 and 3 (@ralphtheninja)

1.2.0 - 2015-11-27

Added

• Add dependency badge (@ralphtheninja)
• Travis: add 1.0, 2, 3, 4 and 5 (@ralphtheninja)

Changed

• Update levelup to ~1.3.0 (@ralphtheninja)
• Update leveldown to ^1.4.2 (@ralphtheninja)

1.1.0 - 2015-06-09

Changed

• Update levelup to ~1.2.0 (@mcollina)
• Update leveldown to ~1.2.2 (@mcollina)

1.0.0 - 2015-05-19

Changed

• README: add link to level/community repo (@ralphtheninja)

1.0.0-0 - 2015-05-16

Added

• Add Travis (@ralphtheninja)
• Add leveldown dev dependency (@ralphtheninja)

Changed

• Update levelup to ~1.0.0 (@ralphtheninja)
• Run tests using packager(leveldown) (@ralphtheninja)

Removed

• Remove level dependency (@ralphtheninja)

0.19.7 - 2015-05-10

Added

• Add level-test-* to .gitignore (@juliangruber)

Changed

• Run the tests if they are not required (@juliangruber)
• Rename the repository to packager (@juliangruber)

0.19.6 - 2015-05-10

Fixed

• Fix incorrect options logic (@juliangruber)

0.19.5 - 2015-05-10

Fixed

• Fixed bug with missing opening curly brace (@juliangruber)

0.19.4 - 2015-05-10

Changed

• Use typeof instead of util.isFunction() (@juliangruber)

0.19.3 - 2015-05-10

Fixed

• Fix missing closing parenthesis (@juliangruber)

0.19.2 - 2015-05-10

Fixed

• Fix missing closing parenthesis (@ralphtheninja)

0.19.1 - 2015-05-10

Fixed

• null options should not be treated as object (@deian)

0.19.0 - 2015-05-04

Changed

• Plain MIT license (@andrewrk)
• README: update logo and copyright year (@ralphtheninja)
• Update levelup to ~0.19.0 (@ralphtheninja)

0.18.0 - 2013-11-18

Changed

• Bumped version (@rvagg)

0.17.0 - 2013-10-09

This changelog is ordered by semver-version, but the first few releases here did not use semver-valid tags.

:seedling: Initial release.

0.17.0-5 - 2013-10-12

Changed

• Clean up debugging noise (@rvagg)

0.17.0-4 - 2013-10-12

Removed

• Remove copy() (@rvagg)

Fixed

• Fix repair() and destroy() (@rvagg)

0.17.0-3 - 2013-10-12

Fixed

• Made tests compatible with node 0.8 (@rvagg)

0.17.0-2 - 2013-10-12

Added

• Add options to exported tests to handle memdown (@rvagg)

Changed

• README: level -> level-packager (@rvagg)

0.17.0-1 - 2013-10-09

Removed

• Remove tape from devDependencies, allow callers to pass in custom test function (@rvagg)