git ssb

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

Table of Contents

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

constructor

index.js:17-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; alternatively, opts.graph can be used
  • opts.graph {object} an instance of ipld-graph-builder; alternatively, 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:32-36

gets a value given a key

Parameters

• key any

Returns Promise

set

index.js:87-90

stores a value at a given key

Parameters

• key any
• value

Returns Promise

delete

index.js:135-138

deletes a value at a given key

Parameters

• key any

Returns Promise

done

index.js:197-203

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

Returns Promise

flush

index.js:219-222

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

Returns Promise

emptyTreeState

index.js:248-250

returns the state of an empty tree

ArrayConstructor

index.js:256-258

returns an Uint1Array constructor which is used to represent keys

Returns object

getMerkleLink

index.js:265-267

returns a merkle link for some given data

Parameters

• data Buffer the data which you would like to hash

Returns Buffer