ipld/js-ipld-dag-cbor

Name: js-ipld-dag-cbor

Owner: IPLD

Description: JavaScript implementation of the IPLD dag-cbor format.

Created: 2015-08-27 00:16:06.0

Updated: 2018-05-16 09:53:56.0

Pushed: 2018-05-07 10:44:17.0

Homepage:

Size: 104

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

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

m install ipld-dag-cbor

Use in Node.js

t 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.

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.

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

Usage

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

t file = {
me: 'hello.txt',
ze: 11


BOR encoded Buffer
BOR.util.serialize(file, (err, serialized) => {})


.util.deserialize(serialize, (err, node) => {
 (err) {
throw err

nsole.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