ipfs-block

IPFS Block JavaScript Implementation

IPFS implementation of the Block data structure in JavaScript.

Block - A block is a blob of binary data.

Table of Contents

• Install
  • npm
• Usage
  • Node.js
    • Example
  • Browser: Browserify, Webpack, other bundlers
  • Browser: <script> Tag
• API
  • Block
    • new Block(data)
    • block.data
    • block.key([hashAlg,] callback)
• Contribute
• License

Install

npm

> npm i ipfs-block

Usage

Node.js

const Block = require('ipfs-block')

Example

const Block = require('ipfs-block')

// create a block
const block = new Block('hello world')
console.log(block.data)
block.key((err, key) => console.log(err, key))

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>
<!-- OR -->
<script src="https://unpkg.com/ipfs-block/dist/index.js"></script>

API

const Block = require('ipfs-block')

Block

new Block(data)

• data: Buffer|String

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.key([hashAlg,] callback)

• hashAlg: String, optional. Default sha2-256.
• callback: Function

The callback will be called with the multihash of the block's data, as a buffer.

Contribute

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

This repository falls under the IPFS Code of Conduct.

License

MIT