git ssb

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

Table of Contents

• constructor
• get
• set
• delete
• flush
• ArrayConstructor
• toTypedArray

constructor

index.js:20-23

Parameters

• opts
  • opts.root {object} a merkle root to a radix tree. If none, RadixTree will create an new root.
  • 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:112-116

gets a value given a key

Parameters

• key any

Returns Promise

set

index.js:123-166

stores a value at a given key

Parameters

• key any
• value

Returns Promise

delete

index.js:173-224

deletes a value at a given key

Parameters

• key any

Returns Promise

flush

index.js:230-232

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

Returns Promise

ArrayConstructor

index.js:29-31

returns an Uint1Array constructir which is used to repersent keys

Returns object

toTypedArray

index.js:38-40

converts a TypedArray or Buffer to an Uint1Array

Parameters

• array TypedArray the array to convert

Returns TypedArray