mountable-dwtrie/README.md

A dwtrie wrapper that supports mounting of other dwtries

# mountable-dwtrie
[![Build Status](https://travis-ci.com/andrewosh/mountable-dwtrie.svg?token=WgJmQm3Kc6qzq1pzYrkx&branch=master)](https://travis-ci.com/andrewosh/mountable-dwtrie)

A Hypertrie wrapper that supports mounting of sub-Hypertries.

### Usage
A MountableHypertrie can be mounted within another MountableHypertrie by using the `mount` command:
```js
const store = dwebx(ram)
const trie1 = new MountableHypertrie(store)
const trie2 = new MountableHypertrie(store)

trie2.ready(() => {
  trie1.mount('/a', trie2.key, ...)
})
```
Assuming `trie2` has a value 'hello' at `/b/c`:
```js
trie1.get('/a/b/c', console.log) // Will return Buffer.from('hello')
```

A mount can be removed by performing a `del` on the mountpoint :
```js
trie1.del('/a', err => {
  trie1.get('/a/b/c', console.log) // Will print `null`
})
```
### API
`mountable-dwtrie` re-exposes the [`dwtrie`](https://github.com/distributedweb/dwtrie) API, with the addition of the following methods (and a different constructor):

#### `const trie = new MountableHypertrie(dwebx, key, opts)`
- `dwebx`: any object that implements the dwebx interface. For now, it's recommanded to use [`random-access-dwebx`](https://github.com/andrewosh/random-access-dwebx)
- `key` is the dwtrie key
- `opts` can contain any `dwtrie` options

#### `trie.mount(path, key, opts, cb)`
- `path` is the mountpoint
- `key` is the key for the MountableHypertrie to be mounted at `path`

`opts` can include:
```
{
  remotePath: '/remote/path', // An optional base path within the mount.
  version: 1                  // An optional checkout version
}
```

_Note: We're still adding support for many dwtrie methods. Here's what's been implemented so far:_

- [x] `get`
- [x] `put`
- [x] `del`
- [ ] `batch`
- [x] `iterator`
- [x] `list`
- [x] `createReadStream`
- [ ] `createWriteStream`
- [x] `checkout`
- [x] `watch`
- [ ] `createHistoryStream`
- [x] `createDiffStream`

### License
MIT