Michael Freno
7c684a42cc
- Consolidated duplicate UndoManagers to single instance - Fixed connection promise to only resolve on 'connected' status - Fixed WebSocketProvider import (WebsocketProvider) - Added proper doc.destroy() cleanup - Renamed isPresenceInitialized property to avoid conflict Co-Authored-By: Paperclip <noreply@paperclip.ing>
57 lines
3.2 KiB
Markdown
57 lines
3.2 KiB
Markdown
# level-packager
|
|
|
|
> `levelup` package helper for distributing with an `abstract-leveldown` compatible back-end
|
|
|
|
[![level badge][level-badge]](https://github.com/Level/awesome)
|
|
[](https://www.npmjs.com/package/level-packager)
|
|
[](https://www.npmjs.com/package/level-packager)
|
|
[](https://travis-ci.com/Level/packager)
|
|
[](https://coveralls.io/github/Level/packager)
|
|
[](https://standardjs.com)
|
|
[](https://www.npmjs.com/package/level-packager)
|
|
[](#backers)
|
|
[](#sponsors)
|
|
|
|
## API
|
|
|
|
Exports a single function which takes a single argument, an `abstract-leveldown` compatible storage back-end for [`levelup`](https://github.com/Level/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`](https://github.com/Level/encoding-down).
|
|
|
|
The constructor function has a `.errors` property which provides access to the different error types from [`level-errors`](https://github.com/Level/errors#api).
|
|
|
|
For example use-cases, see:
|
|
|
|
- [`level`](https://github.com/Level/level)
|
|
- [`level-mem`](https://github.com/Level/level-mem)
|
|
- [`level-hyper`](https://github.com/Level/level-hyper)
|
|
- [`level-lmdb`](https://github.com/Level/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`](UPGRADING.md).
|
|
|
|
## Contributing
|
|
|
|
[`Level/packager`](https://github.com/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](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.
|
|
|
|
## Donate
|
|
|
|
To sustain [`Level`](https://github.com/Level) and its activities, become a backer or sponsor on [Open Collective](https://opencollective.com/level). Your logo or avatar will be displayed on our 28+ [GitHub repositories](https://github.com/Level) and [npm](https://www.npmjs.com/) packages. 💖
|
|
|
|
### Backers
|
|
|
|
[](https://opencollective.com/level)
|
|
|
|
### Sponsors
|
|
|
|
[](https://opencollective.com/level)
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE.md) © 2013-present [Contributors](CONTRIBUTORS.md).
|
|
|
|
[level-badge]: https://leveljs.org/img/badge.svg
|