# platon-web3-providers-ws

> Module to handle web3 RPC connections over WebSockets.

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

## Install

```sh
npm install platon-web3-providers-ws
pnpm add platon-web3-providers-ws
yarn add platon-web3-providers-ws
bun add platon-web3-providers-ws
```

## 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.5 |
| 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 | 17.3 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 19908 |
| Maintainers | rileyge |

## Links

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

## Dependencies (3)

- [underscore](https://npm.io/package/underscore.md) 1.9.1
- [@web3-js/websocket](https://npm.io/package/@web3-js/websocket.md) ^1.0.29
- [platon-web3-core-helpers](https://npm.io/package/platon-web3-core-helpers.md) 1.2.4

## Recent versions

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

## 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('web3-providers-ws');

var options = {
    timeout: 30000,
    headers: { authorization: 'Basic username:password' }
}; // set a custom timeout at 30 seconds, and credentials (you can also add the credentials to the URL: ws://username:password@localhost:8546)
var ws = new Web3WsProvider('ws://localhost:8546', options);
```

## Types

All the typescript typings are placed in the types folder.

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

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