# @vapory/web3-providers-ws

> Module to handle web3 RPC connections over WebSockets.

Latest version **1.0.0-delta.30** (published 2021-02-04) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @vapory/web3-providers-ws
pnpm add @vapory/web3-providers-ws
yarn add @vapory/web3-providers-ws
bun add @vapory/web3-providers-ws
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-delta.30 |
| Published | 2021-02-04 |
| First published | 2021-01-23 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | marlonhanks |

## Links

- npm: https://www.npmjs.com/package/@vapory/web3-providers-ws
- Repository: https://github.com/vaporyco/web3.js/tree/master/packages/web3-providers-ws
- npm.io page: https://npm.io/package/@vapory/web3-providers-ws

## Dependencies (3)

- [websocket](https://npm.io/package/websocket.md) git://github.com/frozeman/WebSocket-Node.git#browserifyCompatible
- [underscore](https://npm.io/package/underscore.md) 1.8.3
- [@vapory/web3-core-helpers](https://npm.io/package/@vapory/web3-core-helpers.md) 1.0.0-delta.30

## Recent versions

- 1.0.0-delta.30 (latest) — 2021-02-04
- 1.0.0-gamma.30 — 2021-01-26
- 1.0.0-beta.30 — 2021-01-24
- 1.0.0-beta.28 — 2021-01-23

## README

# web3-providers-ws

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

This is a websocket provider for [web3.js][repo].   
Please read the [documentation][docs] for more.

## Installation

### Node.js

```bash
npm install web3-providers-ws
```

### In the Browser

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

```bash
npm run-script build-all
```

Then include `dist/web3-providers-ws.js` in your html file.
This will expose the `Web3WsProvider` object on the window object.


## Usage

```js
// in node.js
var Web3WsProvider = require('@vapory/web3-providers-ws');

var ws = new Web3WsProvider('ws://localhost:8546');
```


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

---
_Source: https://npm.io/package/@vapory/web3-providers-ws · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._