Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebsocketProvider

Hierarchy

  • WebsocketProviderBase
    • WebsocketProvider

Index

Constructors

Properties

Methods

Constructors

constructor

  • new WebsocketProvider(host: string, options?: WebsocketProviderOptions): WebsocketProvider

  • Parameters

    • host: string
    • Optional options: WebsocketProviderOptions

    Returns WebsocketProvider

Properties

connected

connected: boolean

connection

connection: any

requestQueue

requestQueue: Map<string, RequestItem>

responseQueue

responseQueue: Map<string, RequestItem>

Methods

connect

  • connect(): void

  • Returns void

disconnect

  • disconnect(code?: number, reason?: string): void

  • Parameters

    • Optional code: number
    • Optional reason: string

    Returns void

isConnecting

  • isConnecting(): boolean

  • Returns boolean

on

  • on(type: string, callback: (() => void)): void

  • Parameters

    • type: string
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

once

  • once(type: string, callback: (() => void)): void

  • Parameters

    • type: string
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

reconnect

  • reconnect(): void

  • Returns void

removeAllListeners

  • removeAllListeners(type: string): void

  • Parameters

    • type: string

    Returns void

removeListener

  • removeListener(type: string, callback: (() => void)): void

  • Parameters

    • type: string
    • callback: (() => void)
        • (): void

        • Returns void

    Returns void

reset

  • reset(): void

  • Returns void

send

  • send(payload: JsonRpcPayload, callback: ((error: Error, result?: JsonRpcResponse) => void)): void

  • Parameters

    • payload: JsonRpcPayload
    • callback: ((error: Error, result?: JsonRpcResponse) => void)
        • (error: Error, result?: JsonRpcResponse): void

        • Parameters

          • error: Error
          • Optional result: JsonRpcResponse

          Returns void

    Returns void

supportsSubscriptions

  • supportsSubscriptions(): boolean

  • Returns boolean

Generated using TypeDoc