naure / js-ipld-dag-cbor

JavaScript implementation of the IPLD dag-cbor format.

js-ipld-dag-cbor

JavaScript implementation of the IPLD spec.

Lead Maintainer

Volker Mische

Table of Contents

• Install
  • npm
  • Use in Node.js
  • Use in a browser with browserify, webpack or any other bundler
  • Use in a browser Using a script tag
• Usage
• Contribute
• License

Install

npm

> npm install ipld-dag-cbor

Use in Node.js

const dagCBOR = require('ipld-dag-cbor')

Use in a browser with browserify, webpack or any other bundler

The code published to npm that gets loaded on require is in fact a ES5 transpiled version with the right shims added. This means that you can require it and use with your favourite bundler without having to adjust asset management process.

var dagCBOR = require('ipld-dag-cbor')

Use in a browser Using a script tag

Loading this module through a script tag will make the IpldDagCbor obj available in the global namespace.

<script src="https://unpkg.com/ipld-dag-cbor/dist/index.min.js"></script>
<!-- OR -->
<script src="https://unpkg.com/ipld-dag-cbor/dist/index.js"></script>

Usage

const dagCBOR = require('ipld-dag-cbor')

const file = {
  name: 'hello.txt',
  size: 11
}

// CBOR encoded Buffer
dagCBOR.util.serialize(file, (err, serialized) => {})


dagCBOR.util.deserialize(serialized, (err, node) => {
  if (err) {
    throw err
  }
  console.log(node)
})

Contribute

Feel free to join in. All welcome. Open an issue!

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to IPLD are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © 2015 David Dias