Usage no npm install needed!

<script type="module">
  import ianaya89Web3ProvidersWs from 'https://cdn.skypack.dev/@ianaya89/web3-providers-ws';
</script>

README

web3-providers-ws

This is a sub package of web3.js

This is a websocket provider for web3.js.
Please read the documentation for more.

Installation

Node.js

npm install web3-providers-ws

In the Browser

Build running the following in the web3.js repository:

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

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

var options = { timeout: 5000 } // set a custom timeout at 5 seconds
var ws = new Web3WsProvider('ws://localhost:8546', options);