Package Exports
- hamt-sharding
- hamt-sharding/src/bucket
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hamt-sharding) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
hamt-sharding
JavaScript implementation of hamt for use in sharding
Lead Maintainer
Table of Contents
Install
> npm install hamt-shardingUsage
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')) // undefinedbucket.leafCount()
const { createHAMT } = require('hamt-sharding')
const bucket = createHAMT({...})
console.info(bucket.leafCount()) // 0
await bucket.put('key', 'value')
console.info(bucket.leafCount()) // 1bucket.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 algorithmbucket.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'
}bucket.serialize(map, reduce)
bucket.asyncTransform(asyncMap, asyncReduce)
bucket.toJSON()
bucket.prettyPrint()
bucket.tableSize()
Contribute
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
