This is a sub package of web3.js
npm install web3-providers-ws
In the Browser
Build running the following in the web3.js repository:
npm run-script build-all
dist/web3-providers-ws.js in your html file.
This will expose the
Web3WsProvider object on the window object.
// in node.jsvar Web3WsProvider = ;var options =timeout: 30000headers: 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 = 'ws://localhost:8546' options;
All the typescript typings are placed in the types folder.