Package Exports

@danielsmilo/web3-providers-ws

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@danielsmilo/web3-providers-ws) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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('@danielsmilo/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);