Nonstop Progressive Marxism

    @alayanetwork/web3-providers-ws
    TypeScript icon, indicating that this package has built-in type declarations

    0.13.2 • Public • Published

    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: 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.

    Keywords

    none

    Install

    npm i @alayanetwork/web3-providers-ws

    DownloadsWeekly Downloads

    15

    Version

    0.13.2

    License

    LGPL-3.0

    Unpacked Size

    17.2 kB

    Total Files

    7

    Last publish

    Collaborators

    • avatar