# platon-web3-core-subscriptions

> Manages web3 subscriptions. This is an internal package.

Latest version **1.2.4** (published 2021-12-28) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install platon-web3-core-subscriptions
pnpm add platon-web3-core-subscriptions
yarn add platon-web3-core-subscriptions
bun add platon-web3-core-subscriptions
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.4 |
| Published | 2021-12-28 |
| First published | 2021-12-28 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 3 |
| Unpacked size | 18.7 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 19919 |
| Maintainers | rileyge |

## Links

- npm: https://www.npmjs.com/package/platon-web3-core-subscriptions
- Repository: https://github.com/ethereum/web3.js/tree/1.x/packages/web3-core-subscriptions
- npm.io page: https://npm.io/package/platon-web3-core-subscriptions

## Dependencies (3)

- [underscore](https://npm.io/package/underscore.md) 1.9.1
- [eventemitter3](https://npm.io/package/eventemitter3.md) 3.1.2
- [platon-web3-core-helpers](https://npm.io/package/platon-web3-core-helpers.md) 1.2.4

## Recent versions

- 1.2.4 (latest) — 2021-12-28
- 1.2.7-beta.0 (beta) — 2021-12-29

## README

# web3-core-subscriptions

This is a sub package of [web3.js][repo]

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

## Installation

### Node.js

```bash
npm install web3-core-subscriptions
```

### In the Browser

Build running the following in the [web3.js][repo] repository:

```bash
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

```js
// 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(){ ... });
```


[docs]: http://web3js.readthedocs.io/en/1.0/
[repo]: https://github.com/ethereum/web3.js

---
_Source: https://npm.io/package/platon-web3-core-subscriptions · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._