datastore-level

js-datastore-level

Datastore implementation with levelup backend.

Lead Maintainer

Alex Potsides

Table of Contents

• js-datastore-level
  • Lead Maintainer
  • Table of Contents
  • Install
  • Usage
    • Browser Shimming Leveldown
    • Database names
  • Contribute
  • License

Install

$ npm install datastore-level

Usage

const LevelStore = require('datastore-level')

// Default using leveldown as backend
const store = new LevelStore('path/to/store')

// use in the browser with level.js
const browserStore = new LevelStore('my/db/name', {db: require('level-js')})

// another leveldown compliant backend like memdown
const memStore = new LevelStore('my/mem/store', {db: require('memdown')})

Browser Shimming Leveldown

As leveldown does not work in the browser, LevelStore takes advantage of the browser property in package.json to shim level-js in its place. Most modern bundlers such as webpack, will see the shim and replace it for use in the browser. 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.

const leveljs = require('level-js')
const browserStore = new LevelStore('my/db/name', {
  db: (path) => leveljs(path, {
    prefix: 'IDBWrapper-'
  })
})

More information: https://github.com/Level/level-js/blob/master/UPGRADING.md#new-database-prefix

Contribute

Feel free to join in. All welcome. Open an issue!

This repository falls under the IPFS Code of Conduct.

License

MIT