scality / packager

levelup package helper for distributing with an abstract-leveldown compatible back-end

level-packager

levelup package helper for distributing with an abstract-leveldown compatible back-end

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.

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.

License & Copyright

Copyright (c) 2012-2018 level-packager contributors.

level-packager is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.