web3-core-subscriptions

This is a sub package of web3.js

The subscriptions package used within some web3.js packages. Please read the documentation for more.

Installation

Node.js

npm install web3-core-subscriptions

In the Browser

Build running the following in the web3.js repository:

npm run-script build-all

Then include dist/web3-core-subscriptions.js in your html file. This will expose the Web3Subscriptions object on the window object.

Usage

// in node.js
var Web3Subscriptions = require('web3-core-subscriptions');

var sub = new Web3Subscriptions({
    name: 'subscribe',
    type: 'eth',
    subscriptions: {
        'newBlockHeaders': {
            subscriptionName: 'newHeads',
            params: 0,
            outputFormatter: formatters.outputBlockFormatter
        },
        'pendingTransactions': {
            params: 0,
            outputFormatter: formatters.outputTransactionFormatter
        }
    }
});
sub.attachToObject(myCoolLib);

myCoolLib.subscribe('newBlockHeaders', function(){ ... });