{"bugs":{"url":"https://github.com/ethereum/web3.js/issues"},"dist":{"shasum":"1e19ef59f9844c31a85f1b9c17088a786029c118","tarball":"https://registry.npmjs.org/web3-core-subscriptions/-/web3-core-subscriptions-1.10.1.tgz","fileCount":12,"integrity":"sha512-6B7cA7lUwCAh7X55gTMfFkC9L8en3bddqFi+VNO9SO9af62t2L5xTb8pxZEFirIF4s4qKxKekLgZrRhpmlO3eA==","signatures":[{"sig":"MEQCIHurDoNRmKi+/YQF7mVpztovvnQiqKvWZ/XeWE8CTVxAAiAviU6Y5FW5W2M/G+Lf0kkfj59sPZ7sXiwpUhlIsr6Hyg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":32360},"main":"lib/index.js","name":"web3-core-subscriptions","types":"types/index.d.ts","readme":"# web3-core-subscriptions\n\n[![NPM Package][npm-image]][npm-url]\n\nThis is a sub-package of [web3.js][repo]\n\nThis subscriptions package is used within some [web3.js][repo] packages.\n\nPlease read the [documentation][docs] for more.\n\n## Installation\n\nYou can install the package either using [NPM](https://www.npmjs.com/package/web3-core-subscriptions) or using [Yarn](https://yarnpkg.com/package/web3-core-subscriptions)\n\n### Using NPM\n\n```bash\nnpm install web3-core-subscriptions\n```\n\n### Using Yarn\n\n```bash\nyarn add web3-core-subscriptions\n```\n\n## Usage\n\n```js\nconst Web3Subscriptions = require('web3-core-subscriptions');\n\nconst sub = new Web3Subscriptions({\n    name: 'subscribe',\n    type: 'eth',\n    subscriptions: {\n        'newBlockHeaders': {\n            subscriptionName: 'newHeads',\n            params: 0,\n            outputFormatter: formatters.outputBlockFormatter\n        },\n        'pendingTransactions': {\n            params: 0,\n            outputFormatter: formatters.outputTransactionFormatter\n        }\n    }\n});\nsub.attachToObject(myCoolLib);\n\nmyCoolLib.subscribe('newBlockHeaders', function(){ ... });\n```\n\n[docs]: http://web3js.readthedocs.io/en/1.0/\n[repo]: https://github.com/ethereum/web3.js\n[npm-image]: https://img.shields.io/npm/v/web3-core-subscriptions.svg\n[npm-url]: https://npmjs.org/package/web3-core-subscriptions\n","engines":{"node":">=8.0.0"},"gitHead":"2e62b5347c8ca3559ef26d5f9626054d5ea86124","license":"LGPL-3.0","scripts":{"compile":"tsc -b tsconfig.json","dtslint":"dtslint --localTs ../../node_modules/typescript/lib types"},"_npmUser":{"name":"jdevcs","email":"junaid@chainsafe.io"},"homepage":"https://github.com/ethereum/web3.js/tree/1.x#readme","repository":{"url":"git+https://github.com/ethereum/web3.js.git#1.x","type":"git"},"_npmVersion":"lerna/6.1.0/node@v18.16.0+x64 (linux)","description":"Manages web3 subscriptions. This is an internal package.","directories":{},"maintainers":[{"name":"mpetrunic","email":"marin.petrunic@gmail.com"},{"name":"jdevcs","email":"junaid@chainsafe.io"},{"name":"gregthegreek","email":"gregorymarkou@gmail.com"}],"_nodeVersion":"18.16.0","dependencies":{"eventemitter3":"4.0.4","web3-core-helpers":"1.10.1"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"dtslint":"^3.4.1","typescript":"4.9.5"},"_npmOperationalInternal":{"tmp":"tmp/web3-core-subscriptions_1.10.1_1692014505641_0.741687083114722","host":"s3://npm-registry-packages"},"_id":"web3-core-subscriptions@1.10.1","version":"1.10.1"}