IPFS Block JavaScript Implementation
IPFS implementation of the Block data structure in JavaScript.
Block - A block is a blob of binary data.
Lead Maintainer
Volker Mische
Table of Contents
Install
npm
> npm install ipfs-block
Usage
Node.js
const Block = require('ipfs-block')
Example
const Block = require('ipfs-block')
const block = new Block(new Buffer('hello world'), cid)
console.log(block.data.toString())
Browser: Browserify, Webpack, other bundlers
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.
const Block = require('ipfs-block')
Browser: <script>
Tag
Loading this module through a script tag will make the IpfsBlock
obj available in
the global namespace.
<script src="https://unpkg.com/ipfs-block/dist/index.min.js"></script>
<script src="https://unpkg.com/ipfs-block/dist/index.js"></script>
API
const Block = require('ipfs-block')
Block
new Block(data, cid)
Creates a new block with raw data data
.
block.data
The raw data of the block. Its format matches whatever was provided in its constructor.
block.cid
The cid of the block.
Contribute
Feel free to join in. All welcome. Open an issue!
This repository falls under the IPFS Code of Conduct.
License
MIT