https://github.com/ipfs/js-datastore-level
Datastore implementation with level(up/down) backend
https://github.com/ipfs/js-datastore-level
Last synced: 9 months ago
JSON representation
Datastore implementation with level(up/down) backend
- Host: GitHub
- URL: https://github.com/ipfs/js-datastore-level
- Owner: ipfs
- License: other
- Archived: true
- Created: 2017-03-12T23:53:14.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-03-23T17:04:19.000Z (about 3 years ago)
- Last Synced: 2024-10-29T11:33:37.775Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.51 MB
- Stars: 19
- Watchers: 25
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ⛔️ This module is now part of https://github.com/ipfs/js-stores
# datastore-level
[](https://ipfs.tech)
[](https://discuss.ipfs.tech)
[](https://codecov.io/gh/ipfs/js-datastore-level)
[](https://github.com/ipfs/js-datastore-level/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
> Datastore implementation with level(up|down) backend
## Table of contents
- [Install](#install)
- [Browser `` tag](#browser-script-tag)
- [Usage](#usage)
- [Browser Shimming Leveldown](#browser-shimming-leveldown)
- [Database names](#database-names)
- [License](#license)
- [Contribute](#contribute)
## Install
```console
$ npm i datastore-level
```
### Browser `<script>` tag
Loading this module through a script tag will make it's exports available as `DatastoreLevel` in the global namespace.
```html
<script src="https://unpkg.com/datastore-level/dist/index.min.js">
```
## Usage
```js
import { LevelDatastore } from 'datastore-level'
// Default using level as backend for node or the browser
const store = new LevelDatastore('path/to/store')
// another leveldown compliant backend like memory-level
const memStore = new LevelDatastore(
new MemoryLevel({
keyEncoding: 'utf8',
valueEncoding: 'view'
})
)
```
### Browser Shimming Leveldown
`LevelStore` uses the `level` module to automatically use `level` if a modern bundler is used which can detect bundle targets based on the `pkg.browser` property in your `package.json`.
If you are using a bundler that does not support `pkg.browser`, you will need to handle the shimming yourself, as was the case with versions of `LevelStore` 0.7.0 and earlier.
### Database names
`level-js@3` changed the database prefix from `IDBWrapper-` to `level-js-`, so please specify the old prefix if you wish to continue using databases created using `datastore-level` prior to `v0.12.0`. E.g.
```javascript
import leveljs from 'level-js'
import browserStore = new LevelDatastore(
new Level('my/db/name', {
prefix: 'IDBWrapper-'
})
})
```
More information: [https://github.com/Level/level-js/blob/master/UPGRADING.md#new-database-prefix](https://github.com/Level/level-js/blob/99831913e905d19e5f6dee56d512b7264fbed7bd/UPGRADING.md#new-database-prefix)
## License
Licensed under either of
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )
- MIT ([LICENSE-MIT](LICENSE-MIT) / )
## Contribute
Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-datastore-level/issues).
Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.
Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)