⛔️ This module is now part of https://github.com/ipfs/js-stores

datastore-core

Wrapper implementation for interface-datastore

Table of contents

• Install
  • Browser <script> tag
• Implementations
• Usage
  • BaseDatastore
  • Wrapping Stores
• Contribute
• License
• Contribute

Install

$ npm i datastore-core

Browser <script> tag

Loading this module through a script tag will make it's exports available as DatastoreCore in the global namespace.

<script src="https://unpkg.com/datastore-core/dist/index.min.js"></script>

Implementations

• Wrapper Implementations
  • Mount: src/mount
  • Keytransform: src/keytransform
  • Sharding: src/sharding
  • Tiered: src/tiered
  • Namespace: src/namespace

Usage

BaseDatastore

An base store is made available to make implementing your own datastore easier:

import { BaseDatastore } from 'datastore-core'

class MyDatastore extends BaseDatastore {
  constructor () {
    super()
  }

  async put (key, val) {
    // your implementation here
  }

  async get (key) {
    // your implementation here
  }

  // etc...
}

See the MemoryDatastore for an example of how it is used.

Wrapping Stores

import { Key } from 'interface-datastore'
import {
  MemoryStore,
  MountStore
} from 'datastore-core'

const store = new MountStore({prefix: new Key('/a'), datastore: new MemoryStore()})

Contribute

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

This repository falls under the IPFS Code of Conduct.

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document 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.

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.