Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WsClient

IRISHub Websocket Client

since

v0.17

Hierarchy

  • WsClient

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • url: string

    Returns WsClient

Properties

eventEmitter

eventEmitter: EventEmitter

Event emitter

Methods

connect

  • connect(): void

  • Initialize ws client

    since

    v0.17

    Returns void

disconnect

  • disconnect(): Promise<void>

  • Disconnect from server

    since

    v0.17

    Returns Promise<void>

isReady

  • isReady(): boolean

  • Check if the ws client is connected or not

    since

    v0.17

    Returns boolean

send

  • send(method: string, id: string, query?: undefined | string): void

  • Send subscription to tendermint

    since

    v0.17

    Parameters

    • method: string

      The tendermint rpc method

    • id: string

      The request id which is the same as the incoming response

    • Optional query: undefined | string

      The tendermint query string

    Returns void

Generated using TypeDoc