git ssb

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

Table of Contents

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

constructor

index.js:17-26

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.

getSubTree

index.js:33-38

creates a new instance of RadixTree that is the subTree of the given key

Parameters

• key any
• decode

Returns Promise resolve to the new instance of RadixTree

get

index.js:45-50

gets a value given a key

Parameters

• key any
• decode

Returns Promise

set

index.js:100-103

stores a value at a given key

Parameters

• key any
• value

Returns Promise

delete

index.js:148-151

deletes a value at a given key

Parameters

• key any

Returns Promise

done

index.js:210-216

returns a promise that resolve when the tree is done with all of its writes

Returns Promise

flush

index.js:232-235

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

Returns Promise

emptyTreeState

index.js:265-267

returns the state of an empty tree

ArrayConstructor

index.js:273-275

returns an Uint1Array constructir which is used to repersent keys

Returns object

getMerkleLink

index.js:282-284

returns a merkle link for some given data

Parameters

• data Buffer the data which you would like to hash

Returns Buffer