git ssb

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

Table of Contents

• constructor
• get
• set
• delete
• flush
• emptyTreeState
• ArrayConstructor
• getMerkleLink

constructor

index.js:18-25

Parameters

• opts
  • opts.root {object} a merkle root to a radix tree. If none, RadixTree will create an new root.
  • opts.db {object} a level db instance alternitly opts.graph can be used
  • opts.graph {object} an instance of ipld-graph-builder alternitvly opts.dag can be used
  • opts.dag {object} an instance if ipfs.dag. If there is no opts.graph this will be used to create a new graph instance.

get

index.js:114-122

gets a value given a key. The promise resolves with an object containing node the node in the merkle tree and value the value of the that the node contains

Parameters

• key any
• decode

Returns Promise

set

index.js:129-167

stores a value at a given key

Parameters

• key any
• value

Returns Promise

delete

index.js:174-226

deletes a value at a given key

Parameters

• key any

Returns Promise

flush

index.js:232-234

creates a merkle root for the current tree and stores the data perstantly

Returns Promise

emptyTreeState

index.js:30-32

returns the state of an empty tree

ArrayConstructor

index.js:38-40

returns an Uint1Array constructir which is used to repersent keys

Returns object

getMerkleLink

index.js:47-49

returns a merkle link for some given data

Parameters

• data Buffer the data which you would like to hash

Returns Buffer