JSPM

  • Created
  • Published
  • Downloads 468207
  • Score
    100M100P100Q188584F
  • License LGPL-3.0

Manages web3 subscriptions. This is an internal package.

Package Exports

  • web3-core-subscriptions
  • web3-core-subscriptions/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (web3-core-subscriptions) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

web3-core-subscriptions

NPM Package

This is a sub-package of web3.js

This subscriptions package is used within some web3.js packages.

Please read the documentation for more.

Installation

You can install the package either using NPM or using Yarn

Using NPM

npm install web3-core-subscriptions

Using Yarn

yarn add web3-core-subscriptions

Usage

const Web3Subscriptions = require('web3-core-subscriptions');

const 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(){ ... });