Package Exports

ipld-graph-builder

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (ipld-graph-builder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SYNOPSIS

This provides an efficent way to build and manipulate IPLD DAGs as JSON. This is accomplished by only producing merkle roots when flushing the DAG. If any object has a "/" property, its value will be replaces with merlke has of that value when flushed. This allows you to build object anyway you like.

INSTALL

npm install ipld-graph-builder

USAGE

const IPFS = require('ipfs')
const Graph = require('../')
const ipfs = new IPFS()

ipfs.on('start', () => {
  const graph = new Graph(ipfs.dag)
  const a = {
    some: {
      thing: 'nested'
    }
  }
  const b = {
    lol: 1
  }

  graph.set(a, 'some/thing/else', b).then(result => {
      // set "patches" together two objects
      console.log(result)
      > 'some': {
      >   'thing': {
      >     'else': {
      >       '/': {
      >         'lol': 1
      >       }
      >     }
      >   }
      > }

      // flush replaces the links with merkle links
      graph.flush(result).then(cid => {
        console.log(result)
        > 'some': {
        >   'thing': {
        >     'else': {
        >       '/': 'zdpuAtQW2gsryPptovnqM7vweN5Jk9iEssJbfMKWY7F1eyh8j'
        >     }
        >   }
        > }

        // taverse paths through merkle links given a starting vertex
        graph.get(result, 'some/thing/else/lol').then(result2 => {
          console.log(result2)
          > 1
        })
     })
  })
}

API

'./docs/'

TESTS

npm run tests

LICENSE

MPL-2.0