index.md

Table of Contents

• constructor
  • Parameters
• findUnsavedLeafNodes
  • Parameters
• set
  • Parameters
• get
  • Parameters
• tree
  • Parameters
• flush
  • Parameters

constructor

index.js:24-31

Parameters

• dag
• ipfsDag Object an instance of ipfs.dag

findUnsavedLeafNodes

index.js:54-67

given a node on the graph this returns all the leaf node that have not yet been saved

Parameters

• node Object

Returns Array

set

index.js:77-103

sets a value on a root object given its path

Parameters

• node Object
• path String
• value any
• noLink boolean if true, value is added as a plain object instead of a link

Returns Promise

get

index.js:113-117

traverses an object's path and returns the resulting value in a Promise

Parameters

• node Object
• path String
• dropOptions boolean whether to add the encoding options of the nodes when loading from IPFS. Defaults to true

Returns Promise

tree

index.js:161-180

Resolves all the links in an object and does so recusivly for N level

Parameters

• node Object
• levels Integer (optional, default 1)
• dropOptions boolean whether to add the encoding options of the nodes when loading from IPFS. Defaults to true

Returns Promise

flush

index.js:203-214

flush an object to ipfs returning the resulting CID in a promise

Parameters

• node Object
• opts Object encoding options for dag.put (optional, default {})
  • opts.onHash Function a callback that happens on each merklized node. It is given two arguments hash and node which is the node that was hashed

Returns Promise