js-datastore-core

Implementations for interface-datastore.

Lead Maintainer

Alex Potsides

Table of Contents

• Implementations
• Install
• Usage
  • BaseDatastore
  • Wrapping Stores
• Contribute
• License

Implementations

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

Install

$ npm install datastore-core

Usage

BaseDatastore

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

const { 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

MIT