hamt-sharding

JavaScript implementation of hamt for use in sharding

> npm install hamt-sharding

Usage

Example

const { createHAMT } = require('hamt-sharding')
const crypto = require('crypto-promise')

// decide how to hash buffers made from keys, can return a Promise
const hashFn = async (buf) => {
  return crypto
    .createHash('sha256')
    .update(buf)
    .digest()
}

const bucket = createHAMT({
  hashFn: hashFn
})

await bucket.put('key', 'value')

const output = await bucket.get('key')
// output === 'value'

API

const { createHAMT } = require('hamt-sharding')

`bucket.put(key, value)`

const { createHAMT } = require('hamt-sharding')
const bucket = createHAMT({...})

await bucket.put('key', 'value')

`bucket.get(key)`

const { createHAMT } = require('hamt-sharding')
const bucket = createHAMT({...})

await bucket.put('key', 'value')

console.info(await bucket.get('key')) // 'value'

`bucket.del(key)`

const { createHAMT } = require('hamt-sharding')
const bucket = createHAMT({...})

await bucket.put('key', 'value')
await bucket.del('key', 'value')

console.info(await bucket.get('key')) // undefined

`bucket.leafCount()`

const { createHAMT } = require('hamt-sharding')
const bucket = createHAMT({...})

console.info(bucket.leafCount()) // 0

await bucket.put('key', 'value')

console.info(bucket.leafCount()) // 1

`bucket.childrenCount()`

const { createHAMT } = require('hamt-sharding')
const bucket = createHAMT({...})

console.info(bucket.childrenCount()) // 0

await bucket.put('key', 'value')

console.info(bucket.childrenCount()) // 234 -- dependent on hashing algorithm

`bucket.onlyChild()`

`bucket.eachLeafSeries()`

const { createHAMT } = require('hamt-sharding')
const bucket = createHAMT({...})

await bucket.put('key', 'value')

for await (const child of bucket.eachLeafSeries()) {
  console.info(child.value) // 'value'
}